Grove Documentation Testing Platform

Test Code Examples

Use Grove's code example testing infrastructure to validate code examples used in our documentation. See Test Code Examples for an overview of the workflow, supported languages, and detailed instructions on how to set up your environment, create example files, add tests, run tests locally, and snip tested examples for inclusion in documentation.

For guidance on writing tests that prove what your example actually teaches, see Writing Meaningful Tests. For a scannable API reference, see Grove Testing Cheat Sheet.

Validate OpenAPI Specs

Use Grove's OASprey tool to validate OpenAPI specifications. See OpenAPI Spec Validation for detailed instructions on how to add and run tests.

Useful Tooling

Use Grove's custom tooling to simplify your workflow:

• Copier App: Copy files automatically to another repository. See Copy Files Automatically to Another Repo for detailed instructions on how to configure a copier workflow.

• Audit CLI: Perform various audit tasks in the docs-mongodb-internal repository. See Audit CLI for MongoDB Documentation for detailed instructions on how to use the Audit CLI tool.