aboutcode-org / aboutcode-org/www.aboutcode.org
DOCS: Create AboutCode doc system
Open
documentation
- Dominant language
- JavaScript
- Stars
- 9
- Forks
- 18
- PR merge metrics
- No merged PRs in 30d
Description
To improve and standardize the documentation across AboutCode projects, we plan to implement a documentation system on https://aboutcode.readthedocs.io/. This system will consist of pages inspired by the Divio documentation system, which explains the [Diátaxis framework](https://diataxis.fr/) and its application to AboutCode projects.
Beyond outlining how project docs should be structured it the docs system should also provide guidance on README, CONTRIBUTING and repository descriptions.
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.