Create reference documentation
Open
@chrean is already working on this.
Since Jan 24, 2023.
area:docs
- Dominant language
- Ruby
- Stars
- 5.3k
- Forks
- 1.4k
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 62
Description
Navigating code is challenging for new adopters.
Can we create some sort of technical reference? Perhaps with automatic generators from comments blocks, if we have any?
Contributor guide
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.