NVIDIA / NVIDIA/NeMo-Retriever
[DOC]: document all the tasks allowed via the API
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/tree/main/client
Describe the problems in the documentation
The API spec only documents the ExtractTask and the SplitTask. Even the primitives/tasks/ directory or the docs/ directory do not have sufficient documentation on other tasks which makes it hard for a developer to learn how to use or configure other tasks.
(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
Start with the client directory and inspect primitives/tasks/ and docs/ to enumerate the tasks currently available through the API. Compare that inventory with the API specification, then document each task and its configuration and usage so developers can discover and use all supported tasks.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100