NASA-AMMOS / NASA-AMMOS/AIT-Core
Add high level module diagrams for toolkit
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 56
- Forks
- 35
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 3
Description
Adding some high level diagrams to the docs pages covering how the AIT subsystems fit together and interact would be helpful for users.
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 pages and the AIT subsystem boundaries they describe. Map how the subsystems fit together and interact, then add high-level module diagrams to the relevant docs pages; the work is done when users can understand those relationships from the documentation.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100