Documentation
Open
Nobody has claimed this yet.
Code Quality
Documentation
Help wanted
Infrastructure
- Dominant language
- C++
- Stars
- 3.6k
- Forks
- 536
- Avg merge
- 6d 1h
- Merged PRs (30d)
- 3
Description
We should document all the engine's code.
I suggest to use Doxygen, which is widely used. Other alternatives, maybe?
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.
Research direction
The issue names no files, tests, or entry points. Start by mapping the engine's code and defining the documentation scope, then compare Doxygen with the suggested alternatives. Done would require an agreed documentation approach and coverage of the defined engine scope.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation, game-dev
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 15/100