-
Notifications
You must be signed in to change notification settings - Fork 1
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
Add proper documentation for user-facing features #132
Conversation
I have been doing that https://gatsby-theme-iterative-example.herokuapp.com/doc/examples. We can continue documenting any feature we fix/add/update. |
I see you have, and it's definitely a step in the right direction, but we probably want to elaborate more on the docs to the point where we give each feature its own page instead of having one mega-page for all features hidden among all the dummy docs. That work won't go to waste, though! it's a great starting point for where we want to go with this docs site. The quote you have was also more directed toward the features themselves: if I discover a glaring flaw while writing documentation, that code may be fixed in this PR. It could also go the other way if the fix seems like too much to put in here- we can document the issue and follow up on it. |
Thanks @rogermparent. Closing this as I don't see it's being updated any time soon. |
This PR has two main goals:
If any glaring flaws are discovered in feature code and can be handled quickly, I'll consider fixing them and documenting so in this PR. Larger issues that could delay these docs will be noted and handled in follow-ups.