docs: add Kosli Capture Managed Service page #311
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Doc Review | |
| on: | |
| pull_request: | |
| types: | |
| - opened | |
| - reopened | |
| - synchronize | |
| paths: | |
| - '**/*.md' | |
| - '**/*.mdx' | |
| - 'config/navigation.json' | |
| - 'docs.json' | |
| # Cancel any in-flight review when a new commit is pushed to the PR. The | |
| # sticky comment then reflects only the latest PR head, not intermediate | |
| # states. | |
| concurrency: | |
| group: doc-review-${{ github.event.pull_request.number }} | |
| cancel-in-progress: true | |
| jobs: | |
| doc-review: | |
| name: Doc quality review | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 30 | |
| permissions: | |
| contents: read | |
| pull-requests: write | |
| id-token: write # required: used to fetch the GitHub OIDC token | |
| steps: | |
| - name: Harden Runner | |
| uses: step-security/harden-runner@e14015d583714f6e62063499dc959a02595150a1 # v2.21.1 | |
| with: | |
| egress-policy: audit | |
| - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 | |
| with: | |
| fetch-depth: 0 | |
| - name: Run Claude doc review | |
| uses: anthropics/claude-code-action@d75b94d5ad426cb8546e6628b6f5f19b84e5cce1 # v1.0.216 | |
| env: | |
| GH_TOKEN: ${{ github.token }} | |
| with: | |
| allowed_bots: "mintlify,github-actions" | |
| anthropic_federation_rule_id: ${{ vars.ANTHROPIC_FEDERATION_RULE_ID }} | |
| anthropic_organization_id: ${{ vars.ANTHROPIC_ORGANIZATION_ID }} | |
| anthropic_service_account_id: ${{ vars.ANTHROPIC_SERVICE_ACCOUNT_ID }} | |
| track_progress: true | |
| use_sticky_comment: true | |
| # The `doc-review` skill is defined locally in | |
| # `.claude/skills/doc-review/SKILL.md` and is picked up automatically | |
| # from the checked-out repo. | |
| # --allowedTools is a whitelist - the agent can ONLY use these tools | |
| # plus the implicit Read/Grep/Glob set. Bash is scoped to the minimum | |
| # gh subcommands needed to read PR context and post comments. | |
| claude_args: | | |
| --max-turns 30 | |
| --model claude-opus-5 | |
| --allowedTools "mcp__github_inline_comment__create_inline_comment,Bash(gh pr comment:*),Bash(gh pr diff:*),Bash(gh pr view:*)" | |
| prompt: | | |
| REPO: ${{ github.repository }} | |
| PR NUMBER: ${{ github.event.pull_request.number }} | |
| You are reviewing a pull request to the Kosli docs site. Follow | |
| the `doc-review` skill (defined in `.claude/skills/doc-review/SKILL.md`) | |
| and the rules in this repo's CLAUDE.md. | |
| Scope: the docs files (.md, .mdx, config/navigation.json, | |
| docs.json) changed in this PR. Use `gh pr diff` to discover them. | |
| You may read any file in the repo to check the change against it - | |
| cross-file consistency is the most valuable thing you can do here. | |
| Constraints: | |
| - Read each changed file AT THE CURRENT BRANCH HEAD, not just the | |
| diff. Never report something a later commit already fixed. | |
| - Never report spelling. The `vale-spellcheck` check enforces | |
| `styles/Kosli/AmericanSpelling.yml` on every PR. Do not restate | |
| checks that passed, and do not include a "what looks good" | |
| section - the sticky comment re-renders on every push. | |
| - Prioritise the cross-file checks in the skill: prose against | |
| generated reference pages and schemas, and incomplete sweeps | |
| when a concept is renamed or removed. | |
| - If a new page was added, verify it is listed in | |
| `config/navigation.json` (Critical if missing) AND question | |
| whether its tab and group are right for its Diátaxis type. | |
| - If a page was moved, renamed, or deleted, verify | |
| `config/redirects.json` has an entry. Critical if missing. | |
| - Flag relative links (e.g. `../foo`) as Critical - they must be | |
| root-relative. | |
| - GENERATED PAGES: this workflow reviews the automated | |
| `docs: update CLI and helm reference for vX.Y.Z` PRs, whose | |
| diffs are almost entirely machine-generated. Follow the skill's | |
| "Generated pages" section. Do NOT post inline comments on | |
| `client_reference/kosli*.md`, `helm/k8s_reporter/*.mdx` or | |
| `schemas/` - those lines are deleted on the next release. Do NOT | |
| emit a "Fix this" link scoped to this repo for such a page. | |
| Report the finding in the top-level comment under an | |
| "Upstream - does not block this merge" heading, naming the | |
| upstream repo and file (usually `kosli-dev/cli`, | |
| `cmd/kosli/<command>.go` or | |
| `charts/k8s-reporter/mintlify/<page>.md.gotmpl`). | |
| - Do not itemise regenerated sample-data churn (timestamps, | |
| fingerprints, commit SHAs). Confirm it is only churn, say so in | |
| one line, and move on. | |
| - Apply the skill's "What not to report" bar and its 8-finding | |
| cap. If nothing clears the bar, say so in one sentence. | |
| - This review is advisory: do not request changes or approve. | |
| Note: The PR branch is already checked out in the current working | |
| directory. | |
| Use `gh pr comment` for top-level feedback. | |
| Use `mcp__github_inline_comment__create_inline_comment` to highlight | |
| specific issues on individual lines. | |
| Only post GitHub comments - don't submit review text as messages. |