This repo is the Redocly Reunite content source for API reference docs and integration guides. Claude Code Action follows these standards whenever it drafts a documentation update.
- Only touch files related to the specific API change you were given context for in the prompt.
- Never reformat, restructure, or "clean up" unrelated content in a file you're editing.
- Never delete existing guide sections unless the underlying feature was actually removed.
- Do not guess at behavior you can't verify from the provided source diff or checked-out source files.
- Insert
<!-- TODO(docs): needs human input -- [what's unclear] -->at the relevant spot instead, and mention it in the change manifest.
- Guides are short and task-oriented: what the integration does, a minimal working example, common pitfalls. Not marketing copy.
- Organize guides by integration type and vertical:
guides/{integration-type}/{vertical}/. - Match the existing heading structure and tone of neighboring guide files rather than inventing a new style per PR.
- Preserve existing field ordering and formatting conventions in the target YAML file.
- Every path needs a description; every schema needs example values wherever the file already uses them.
- One PR per source-repo sync.
- Title:
Docs sync: {service repo} @ {commit sha}. - Always include the change manifest (
.sync/change-manifest.md) as the PR body. - Never merge your own PR.