Tracking issue: documentation
Open
Nobody has claimed this yet.
help wanted
- Dominant language
- Rust
- Stars
- 425
- Forks
- 163
- Avg merge
- 10h 51m
- Merged PRs (30d)
- 3
Description
For initial release
- Introduction (readme, include in rustdoc, check crate root docs)
- Public API of main crate
- RawClient
- ColumnFamily
- TransactionClient
- Snapshot
- Transaction
- Config
- SecurityManager
- BoundRange
- Error
- ErrorKind
- Key
- KvPair
- Result
- Timestamp
- ToOwnedRange
- Value
- examples (each example is introduced, well-commented, linked from docs)
- enumerate which parts of TiKV's API we support/don't support
For later
- Public API of all crates
Contributor guide
No contributing guide indexed for this repository
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 unchecked public API items in the main crate and the existing examples. Document the listed types and examples, then record which TiKV API parts are supported or unsupported and update the checklist as items are completed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100