generate human readable documentation from yardl files
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 35
- Forks
- 14
- Avg merge
- 5d 17h
- Merged PRs (30d)
- 1
Description
It seems possible to generated "readthedocs" type of documentation from the yardl files. This would probably need stricter guidelines on how to write the documentation, and it might not be so easy to have it organised logically (maybe via some tags).
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.
Research direction
Begin by reviewing the existing yardl files and how their documentation is currently written. Define the intended Read the Docs-style output, rules for documenting fields, and a way to organize generated pages, potentially using tags. Done means the project has an agreed structure and a documented path to generating human-readable documentation from yardl files.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Active
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100