AllTheBacteria / AllTheBacteria/atb-cli
Generate RTD for atb-cli document
Open
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 35
- Forks
- 1
- Avg merge
- 12m
- Merged PRs (30d)
- 2
Description
- atb-cli has a minimal readme: link to RTD, plus how to install, quick start
- atb-cli has complete documentation on RTD, separate from AllTheBacteria main website/docs
- after atb-cli RTD exists, I can rewrite chunks of the current ATB docs where it's easier to use atb-cli
Proposed by @martinghunt
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 inspecting the repository's current README and documentation structure, then determine how the atb-cli documentation should be organized for RTD. Done means an RTD site exists with installation instructions, a quick start, and a README link, separate from the main AllTheBacteria documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100