Mahlet-Inc / Mahlet-Inc/hobbits
Update all documentation for 1.0
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 751
- Forks
- 49
- PR merge metrics
- No merged PRs in 30d
Description
This includes:
- updating published docs on https://mahlet-inc.github.io/
- adding new youtube tutorials
- updating and publishing doxygen documentation in the code
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
Start by reviewing the published documentation at https://mahlet-inc.github.io/ and the existing Doxygen documentation in the code. Define the documentation scope for version 1.0, including the requested YouTube tutorials and publishing steps. Done means the published docs, tutorials, and Doxygen documentation are updated for 1.0.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100