tortoise / tortoise/tortoise-orm
'ReadTheDocs' documentation offline
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 5.6k
- Forks
- 516
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 9
Description
Describe the bug
Not a bug, but noting a disappearance of the Tortoise documentation on ReadTheDocs
To Reproduce
Visit the Tortoise section in ReadTheDocs.io
https://tortoise-orm.readthedocs.io/en/latest/getting_started.html
Expected behavior
Appearance of the valuable documentation
Additional context
There is much needed user information that was readily accessible only through the ReadTheDocs site. Example - modifier suffixes for filtering, which used to be reachable at: https://tortoise-orm.readthedocs.io/en/latest/query.html
Now, for the .filter() keyword modifier suffixes, there is no straightforward way to find the list of these in the GitHub documentation pages.
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 comparing the ReadTheDocs pages for getting started and querying with the documentation currently available in the GitHub repository. Make the user information, including the .filter() modifier suffix list, straightforward to find offline and verify that the relevant documentation is accessible without ReadTheDocs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100