[DOC] Re-write developer guid
Nobody has claimed this yet.
- Dominant language
- Cuda
- Stars
- 854
- Forks
- 236
- Avg merge
- 3d 3h
- Merged PRs (30d)
- 62
Description
The current developer guide was moved over almost directly from RAFT and many of the concepts are different, just plain wrong, or no longer apply to cuVS. We should build a new developer guide just for cuVS that focuses on how we do things here instead of how we did them in RAFT.
Each library should have a developer guide that's targeted to that library explicitly. This isn't a huge priority but something we should update soon as cuVS gets more eyes on it.
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
No files, tests, or documentation entry points are named. Begin by locating the current RAFT-derived developer guide and inventorying the cuVS libraries it covers. Done means each library has a cuVS-specific developer guide that describes current local practices rather than obsolete RAFT concepts.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100