Add better documentation and tutorials of engine usage and architecture.
Open
Nobody has claimed this yet.
documentation
- Dominant language
- C++
- Stars
- 35
- Forks
- 6
- PR merge metrics
- No merged PRs in 30d
Description
I think we can use Doxygen for that and .md files.
There is already a game demo repo: https://github.com/cfnptr/garden-demo
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
Start by reviewing the existing documentation and the garden-demo repository linked in the issue, then assess whether Doxygen and .md files are the appropriate documentation sources. Done means adding clearer tutorials for engine usage and documentation of the engine architecture, with the relevant demo repository incorporated where useful.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp, markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100