documentationjs / documentationjs/documentation
Make documentation syntax more visible?
Open
- Dominant language
- JavaScript
- Stars
- 5.8k
- Forks
- 481
- PR merge metrics
- No merged PRs in 30d
Description
I feel this project could benefit to having the syntax that developers should use more visibly presented. Right now it's hidden away in the [Getting Started](https://github.com/documentationjs/documentation/blob/master/docs/GETTING_STARTED.md) file. I would propose:
- Move the syntax documentation (along with #268, if accepted) to a section in the main README. It doesn't need to contain the whole contents of Getting Started, just a short example that can be used to get started quickly.
- Add this syntax documentation to [the website](http://documentation.js.org/) as well (or maybe just mirror the full contents of the README).
Thoughts?
Contributor guide
Assessment
This issue has not been assessed yet.