documentation should be made consistent
Open
@glennklockwood is already working on this.
Since May 16, 2019.
documentation
enhancement
- Dominant language
- C
- Stars
- 487
- Forks
- 200
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 2
Description
The documentation for IOR and mdtest is pretty inconsistent and scattered across many different files and locations. This meta-issue is meant to track the state of improving the documentation and, for example,
- addressing #138
- addressing #118
- addressing comments in #151
- getting rid of multiple READMEs, USER_GUIDE, etc and creating a single point of truth for documentation
- re-basing and merging https://github.com/glennklockwood/ior/tree/docfixes
- promoting the readthedocs documentation in the repository's top-level README
- adding more Doxygen documentation in the code where appropriate
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.