MongoEngine / MongoEngine/mongoengine
Which documentation site is the official documentation site?
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 4.3k
- Forks
- 1.2k
- Avg merge
- 4h 41m
- Merged PRs (30d)
- 11
Description
As I've been learning how to use the library and googling questions on how to use different commands, I've come across 3 different URLs for the documentation site. Perhaps they all actually point to the same documentation, but as a regular user, I start worrying if one of the documentation sites I'm using is out of date. Especially because all of the links look fairly similar
Links:
- https://mongoengine.readthedocs.io/en/latest/index.html
- https://docs.mongoengine.org/
- https://mongoengine-odm.readthedocs.io/index.html (likely just a subdomain of the first?)
Which documentation site is the recommended / official one, and is it possible to archive the others just to prevent confusion amongst users?
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
Review the three listed documentation URLs and compare whether they serve the same or different content. Start by checking the current project documentation references and the linked sites' status. Done means identifying the recommended official URL and documenting whether the other sites can be archived or redirected.
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
- Active
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100