[SBIN] Add cuvs ABI documentation to the project
Nobody has claimed this yet.
- Dominant language
- Cuda
- Stars
- 854
- Forks
- 236
- Avg merge
- 3d 3h
- Merged PRs (30d)
- 62
Description
Construct comprehensive documentation detailing what are the rules Application Binary Interface (ABI) of the cuvs library, update policy, and proper code rules.
Convert https://docs.google.com/document/d/1xhyPtxJLaozvdD0VC2mW3DT5BjWQJUaMkxJf2bkKIIk/edit?tab=t.0#heading=h.bidb6g3vzi9q into a new docs/source/c_developer_guide.md
Cross reference the c developer guide and the readme and other documentation as needed
copied from https://docs.google.com/document/d/13fxnoZQIvJPKDwz-21fXMrux6HtJG7KW5cHafrmJtAo/edit?usp=sharing
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 reviewing the linked Google document, then inspect the existing documentation structure, README, and any current C developer guidance. Create docs/source/c_developer_guide.md covering cuvs ABI rules, update policy, and code rules, and add cross-references to the README and related documentation as needed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100