mphowardlab / mphowardlab/azplugins
Update documentation style
Open
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 27
- Forks
- 18
- Avg merge
- 1h 8m
- Merged PRs (30d)
- 1
Description
HOOMD changed its documentation style:
https://github.com/glotzerlab/hoomd-blue/pull/1952
We should consider if we want to update azplugins to adhere to this style to make it feel part of HOOMD and make it easier to port code in future.
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 reading HOOMD-blue pull request #1952, then compare its documentation style with azplugins' current documentation. Define the scope of the style update; the work is done when azplugins documentation follows the agreed HOOMD style.
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
- 25/100