NVIDIA / NVIDIA/NeMo-Retriever
[DOC]: Add "blueprint" diagram and explain
Open
Nobody has claimed this yet.
doc
- Dominant language
- Python
- Stars
- 3k
- Forks
- 349
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 116
Description
How would you describe the priority of this documentation request
Significant improvement
Please provide a link or source to the relevant docs
README.md
Describe the problems in the documentation
The README text does not make it clear how parts of the architecture diagram fit together and how NVIDIA NIMs are used. We recommend that the diagram also be explained for clarity.
Diagram:
(Optional) Propose a correction or improvement
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
Open README.md and review the architecture diagram and the surrounding references to NVIDIA NIMs. Clarify how the diagram's components fit together and explain how NVIDIA NIMs are used. Done means the README provides understandable explanatory text alongside the diagram.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100