NVIDIA-NeMo / NVIDIA-NeMo/Safe-Synthesizer
Adjust doc diagrams to be readable
Open
Nobody has claimed this yet.
docs
- Dominant language
- Python
- Stars
- 38
- Forks
- 11
- Avg merge
- 4d 17h
- Merged PRs (30d)
- 9
Description
Priority Level
Medium
Task Summary
Diagrams in docs are too small to read, not providing much value right now.
- High-level architecture diagram - recommend simplifying the diagram to make it truly high level (From bug bash)
- Configuration system diagram - not sure it's actually helpful (from bug bash)
Technical Details & Implementation Plan
No response
Dependencies
No response
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 high-level architecture and configuration system diagrams in the documentation and review them at a readable size. Simplify the architecture diagram so it remains genuinely high level, and decide whether the configuration diagram provides enough value to retain or revise. Done means both diagrams are readable and their purpose is clear.
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
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 38/100