Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(shorthand): add dedicated shorthand docs page #561

Closed
levithomason opened this issue Sep 28, 2016 · 13 comments · Fixed by #3564
Closed

docs(shorthand): add dedicated shorthand docs page #561

levithomason opened this issue Sep 28, 2016 · 13 comments · Fixed by #3564

Comments

@levithomason
Copy link
Member

Shorthand props are at the heart of what makes our API so powerful and easy to work with. With the recent updates and additions to our factories, the shorthand concept is becoming the crux of this library. We're set to only further improve shorthand for arrays, child keys, and prop types. Understanding how to use it is paramount to using Semantic-UI-React.

Shorthand is covered briefly half way down the introduction page. However, it is incomplete and deserves more prominence. We should add a dedicated "Shorthand" page under "Getting Started".

@levithomason
Copy link
Member Author

Include information and examples from #882.

@levithomason
Copy link
Member Author

Include an input example, see #1386.

@brianespinosa
Copy link
Member

@levithomason Assigning this old one over to myself. I'll see about putting something together to help with this.

@brianespinosa
Copy link
Member

I've officially blocked out a day to work on some of this over the holiday. 🎁 🎉

@stale
Copy link

stale bot commented Mar 22, 2018

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 30 days if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Mar 22, 2018
@brianespinosa
Copy link
Member

Poking myself to keep this open.

@stale stale bot removed the stale label Mar 22, 2018
@stale
Copy link

stale bot commented Jun 20, 2018

There has been no activity in this thread for 90 days. While we care about every issue and we’d love to see this fixed, the core team’s time is limited so we have to focus our attention on the issues that are most pressing. Therefore, we will likely not be able to get to this one.

However, PRs for this issue will of course be accepted and welcome!

If there is no more activity in the next 90 days, this issue will be closed automatically for housekeeping. To prevent this, simply leave a reply here. Thanks!

@stale stale bot added the stale label Jun 20, 2018
@layershifter
Copy link
Member

Unstale, please :cat

@stale stale bot removed the stale label Sep 17, 2018
@brianespinosa
Copy link
Member

@layershifter I saw you mention elsewhere that you were thinking about changing to docs to be built with Gatsby. Is that something you are still considering?

If so, we might want to look into something like MDX files to generate our docs. I actually am putting something together with my team that does this right now internally.

@layershifter
Copy link
Member

@brianespinosa we using ReactStatic now.

We can adopt MDX files there, just add an additional loader: https://github.com/Semantic-Org/Semantic-UI-React/blob/master/static.webpack.js#L41

I don't have there a strategy for this now. Feel free to promote it 👍

@brianespinosa
Copy link
Member

Ah got it. Let me see how things pan out with our internal work first and once I have some more feedback on pros/cons I can put a proposal together.

@layershifter
Copy link
Member

@brianespinosa MDX support is added, #3196 ✌️

@stale
Copy link

stale bot commented Apr 2, 2019

There has been no activity in this thread for 180 days. While we care about every issue and we’d love to see this fixed, the core team’s time is limited so we have to focus our attention on the issues that are most pressing. Therefore, we will likely not be able to get to this one.

However, PRs for this issue will of course be accepted and welcome!

If there is no more activity in the next 180 days, this issue will be closed automatically for housekeeping. To prevent this, simply leave a reply here. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants