mdolab / mdolab/OpenAeroStruct
Review documentation in depth and modify as needed
Open
Nobody has claimed this yet.
enhancement
good first issue
help wanted
- Dominant language
- Python
- Stars
- 281
- Forks
- 135
- PR merge metrics
- No merged PRs in 30d
Description
The docs were kind of stitched together from a variety of ideas at different times.
Go through these docs holistically and update / rearrange as necessary.
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
Review the project's documentation holistically to identify inconsistent or outdated sections and determine what should be rearranged. Done means the documentation has a coherent structure and the necessary content updates are complete, but the issue does not name specific files, tests, or an entry point.
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