Use after implementing features, changing configuration, modifying CLI commands, updating router behavior, altering architecture, or making any user-facing changes. Triggers a documentation review to check if docs-website/ needs updating. Use this skill whenever you finish writing code that changes how users interact with the platform — new flags, config options, API changes, new UI features, behavioral changes, deprecations, or new components. Even small changes like adding an environment variable or a new CLI flag need doc coverage.
After making code changes that affect user-facing behavior, check whether the documentation in docs-website/ needs to be updated. Outdated or missing documentation is one of the most common sources of user frustration — users read the docs expecting them to match reality, and when they don't, trust erodes. This skill ensures documentation stays in sync with code.
This check applies when changes touch any of these areas:
If the changes are purely internal (refactoring, test-only, CI config, internal code reorganization with no behavioral change), skip the doc check.
Look at the changes you just made (or use git diff if needed). Categorize them:
Use this mapping to find which docs might need updating:
| Code area | Documentation section | Key files |
|---|---|---|
router/ (Go) | docs-website/router/ | router/configuration.mdx for config, feature-specific pages |
router/pkg/config/ | docs-website/router/configuration.mdx | Config schema → config reference |
cli/src/commands/ | docs-website/cli/ | One doc page per CLI command, organized by resource |
controlplane/ | docs-website/control-plane/ | API docs, webhooks, RBAC |
studio/ | docs-website/studio/ | Feature pages matching UI sections |
composition/ or composition-go/ | docs-website/federation/ | Directives, composition rules |
helm/ | docs-website/deployments-and-hosting/kubernetes/ | Helm chart docs |
proto/ | docs-website/control-plane/ | API reference pages |
aws-lambda-router/ | docs-website/router/deployment/ | Lambda deployment guide |
docker/ | docs-website/deployments-and-hosting/docker.mdx | Docker setup |
cdn-server/ | docs-website/deployments-and-hosting/ | CDN configuration |
| New concepts (feature flags, namespaces, etc.) | docs-website/concepts/ | Concept explainer pages |
graphqlmetrics/ | docs-website/router/metrics-and-monitoring/ | Metrics docs |
otelcollector/ | docs-website/router/open-telemetry/ | OpenTelemetry docs |
Read the existing documentation pages that correspond to your changes. Check for:
If a new documentation page is needed, it must be added to docs-website/docs.json in the appropriate navigation group. Read docs.json to verify the page is listed.
The navigation is organized into three tabs:
Tell the user what you found. Be specific:
Then ask the user if they want you to make the documentation updates now.
When writing or updating docs, follow these conventions:
title, description, optional icon and sidebarTitle)<Info>, <Note>, <Warning> for important informationdocs-website/images/[topic]/, reference as /images/topic/filename.pngyaml, graphql, ```bash, etc.)/router/configurationrouter/configuration.mdx) must be updated along with any feature-specific page