This repository was archived by the owner on Nov 8, 2024. It is now read-only.
This repository was archived by the owner on Nov 8, 2024. It is now read-only.
Improve user facing documentation #17
Open
Description
Rough notes, but roughly the following documents or changes in place:
- README - At a high level to describe the sub-packages, linking to subpackage readmes
- CONTRIBUTING Docs - Check out the ones in Dredd these are helpful, we should contain links to Drafter, API Elements specification etc and provide potential contributor all information they need to contribute back. Check out Dredd for good example
- New Issue Template - We can offer users a guide/new issue template in GitHub for information we need and where to file bugs.
- Sub-Package Readmes
- Update docs/ to provide full API Reference and documentation for all packages.
- Integrate documentation generation with NPM, see https://github.com/apiaryio/api-elements.js/pull/16/files/57abbcea8ba36a405ef8b20fc6387846e37901bb#r235005622
@honzajavorek has done a great job with Dredd and I think we can take some ideas and bring them over here too!