This repository contains the MongoDB documentation, accessible at https://www.mongodb.com/docs/
The MongoDB Documentation Project is governed by the terms of the MongoDB Contributor Agreement.
To contribute to the documentation,
If you have not done so already, please sign the MongoDB Contributor Agreement.
Fork this repository on GitHub and issue a pull request.
To file issues or requests regarding the documentation, use the "Rate this page" feedback widget on the right side of docs pages and leave a comment.
The .github/ folder contains documentation automation tools. Follow these conventions:
.github/
├── lint-docs/ # Doc linters (flat structure)
│ ├── seo-lint-cli.ts
│ ├── seo-lint-rules.ts
│ ├── 404-lint-cli.ts
│ ├── package.json
│ └── tsconfig.json
├── ai-reviewer/ # AI style reviewer
├── cspell/ # Spell checking config
└── workflows/ # GitHub Actions
- Flat structure over nesting: Put related files directly in one folder rather than creating subfolders
- Prefix file names: Use prefixes like
seo-lint-,404-lint-for better IDE tab visibility - Single package.json: Each tool folder should have one shared
package.json
When creating new automation tools:
- Create a folder at
.github/<tool-name>/ - Use descriptive file prefixes (e.g.,
tool-name-cli.ts,tool-name-rules.ts) - Include
package.json,tsconfig.json, and a brief README
All documentation is available under the terms of a Creative Commons License.