{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Project standards for this docs repo"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"project-standards-for-this-docs-repo","__idx":0},"children":["Project standards for this docs repo"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"scope-discipline","__idx":1},"children":["Scope discipline"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Only touch files related to the specific API change you were given"," ","context for in the prompt."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Never reformat, restructure, or \"clean up\" unrelated content in a"," ","file you're editing."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Never delete existing guide sections unless the underlying feature"," ","was actually removed."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"when-youre-not-sure","__idx":2},"children":["When you're not sure"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Do not guess at behavior you can't verify from the provided source"," ","diff or checked-out source files."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Insert ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<!-- TODO(docs): needs human input -- [what's unclear] -->"]}," ","at the relevant spot instead, and mention it in the change manifest."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"guide-style","__idx":3},"children":["Guide style"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Guides are short and task-oriented: what the integration does, a"," ","minimal working example, common pitfalls. Not marketing copy."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Organize guides by integration type and vertical:"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["guides/{integration-type}/{vertical}/"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Match the existing heading structure and tone of neighboring guide"," ","files rather than inventing a new style per PR."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"openapi-spec-changes","__idx":4},"children":["OpenAPI spec changes"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Preserve existing field ordering and formatting conventions in the"," ","target YAML file."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Every path needs a description; every schema needs example values"," ","wherever the file already uses them."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"pull-requests","__idx":5},"children":["Pull requests"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["One PR per source-repo sync."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Title: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Docs sync: {service repo} @ {commit sha}"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Always include the change manifest (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".sync/change-manifest.md"]},") as"," ","the PR body."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Never merge your own PR."]}]}]},"headings":[{"value":"Project standards for this docs repo","id":"project-standards-for-this-docs-repo","depth":1},{"value":"Scope discipline","id":"scope-discipline","depth":2},{"value":"When you're not sure","id":"when-youre-not-sure","depth":2},{"value":"Guide style","id":"guide-style","depth":2},{"value":"OpenAPI spec changes","id":"openapi-spec-changes","depth":2},{"value":"Pull requests","id":"pull-requests","depth":2}],"frontmatter":{"seo":{"title":"Project standards for this docs repo"}},"lastModified":"2026-09-11T10:21:47.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/claude","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}