Is there a readthedocs.io docs website coming soon?
Open
Nobody has claimed this yet.
documentation
enhancement
- Dominant language
- Python
- Stars
- 1.5k
- Forks
- 204
- Avg merge
- 13m
- Merged PRs (30d)
- 1
Description
Hello!
Thanks for building this 😄 I was hoping to know when there'll be a documentation website (say, something on readthedocs.io). I'm aware that there are markdown files in docs/ but it'd be awesome to have a docs site to see things more clearly.
I'm available to help develop the docs if needed as well.
Thanks!
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 Markdown files in docs/ and the request for a readthedocs.io site. Determine whether a documentation website is planned and define the scope and acceptance criteria before beginning any contribution.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100