Quickstart

Use this flow to validate a DevDocs-managed docs repository.

1. Create a branch

Create a branch for a documentation change:

git checkout -b docs/update-welcome-copy

2. Edit content

Change an MDX page under docs/, update docs.json, or add a new OpenAPI file under openapi/.

3. Open a pull request

When the pull request opens, DevDocs should create a preview deployment and publish the preview URL back to GitHub checks.

4. Merge to main

After review, merge the pull request. DevDocs should publish production from main.

Expected repository shape

This repository should stay documentation-only:

• MDX pages in docs/
• Configuration in docs.json or mint.json
• OpenAPI files in openapi/
• Snippets in snippets/
• Static docs assets in images/