Mesh classes: provide usage notes and narrative descriptions
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 287
- Forks
- 109
- Avg merge
- 4d 41m
- Merged PRs (30d)
- 5
Description
What needs to be documented?
Having a UML for the mesh is useful, but in addition, having a narrative description of each of the mesh classes, with their reason to exist, would help.
What sort of documentation would help?
User guide and Doxygen.
What are the deficiencies of the existing documentation?
The existing documentation focuses on technical aspects, but does not provide much context for each class usage.
Additional notes or context
Doc Day task. Feedback from @jiemeng-total
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 locating the mesh classes and the existing UML, user guide, and Doxygen documentation. Document each class's reason to exist and typical usage in the user guide and Doxygen, with enough narrative context to address the current technical focus.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100