NVIDIA / NVIDIA/NeMo-Retriever
[DOC]: Add a "Next Steps" section for more production-grade setup
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
None
Please provide a link or source to the relevant docs
https://github.com/NVIDIA/nv-ingest/blob/main/README.md
Describe the problems in the documentation
please add a “Next Steps” section that points a user to a more production-grade setup using the helm chart as well as how to develop further (for example with the retrieval pipelines as shown here).
(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 its current setup guidance, then follow the linked Helm chart and retrieval-pipeline example to understand the intended next steps. Add a “Next Steps” section linking users to the production-grade Helm setup and further development guidance, including retrieval pipelines.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- helm
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100