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

Better organize existing Markdown documentation #1323

Closed
nylen opened this issue Jun 21, 2017 · 2 comments
Closed

Better organize existing Markdown documentation #1323

nylen opened this issue Jun 21, 2017 · 2 comments
Labels
[Type] Developer Documentation Documentation for developers [Type] Task Issues or PRs that have been broken down into an individual action to take

Comments

@nylen
Copy link
Member

nylen commented Jun 21, 2017

We have multiple Markdown documentation files within the Gutenberg repository that are currently not so easy to find: https://github.com/WordPress/gutenberg/search?l=Markdown

Potential ways to improve this:

  • Build a table of contents into the main readme, or other ways of pointing to these documents.
  • Integrate more of our existing documentation into http://gutenberg-devdoc.surge.sh/ (and prominently link to this site from our main readme).
@nylen nylen added [Type] Developer Documentation Documentation for developers [Type] Task Issues or PRs that have been broken down into an individual action to take labels Jun 21, 2017
@youknowriad
Copy link
Contributor

I've already included most of them in http://gutenberg-devdoc.surge.sh/ but we should definitely link to the site from the README 👍

We should also add more documentation to our components, we have only one component documented right now.

@mtias
Copy link
Member

mtias commented Aug 18, 2017

This will be linked from a canonical page under .org website.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers [Type] Task Issues or PRs that have been broken down into an individual action to take
Projects
None yet
Development

No branches or pull requests

3 participants