docs: there should be documentation aimed at Ti{DB|KV|Flash} devs
Open
Nobody has claimed this yet.
category/document
category/usability
- Dominant language
- Go
- Stars
- 466
- Forks
- 338
- Avg merge
- 3d 7h
- Merged PRs (30d)
- 8
Description
As a TiKV dev wanting to use TiUp to test my code, there is no documentation for me.
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 file, test, or documentation entry point is named. Start by reviewing the existing TiUp documentation and its guidance for TiKV developers, then define the missing testing workflow and document it. Done means TiKV developers can use TiUp to test their code from the new documentation.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100