MongoEngine / MongoEngine/mongoengine
Docs for older mongoengine releases are not visible on Read the Docs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 4.3k
- Forks
- 1.2k
- Avg merge
- 4h 41m
- Merged PRs (30d)
- 11
Description
We use mongoengine 0.7.10, and I'm constantly reading the docs from github directly instead of reading the on Read the Docs. The Read the Docs site only shows 'latest'. I think that previous releases or release streams should be versioned in Read the Docs. Just enable builders in RTD config for the release branch or each tagged release. I think doing the release branches is probably the best thing to do.
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 locating the Read the Docs configuration and reviewing how the release branches or tagged releases are represented. Enable documentation builders for the appropriate older release streams, then verify that the Read the Docs site makes those versions selectable alongside latest.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100