Repository navigation
docs: trim seven near-cap flow and guide pages under the word limit - #1084
Merged
Merged
Conversation
…e word limit docs:check-length fails any page above 2,500 words, and these pages sat at 2,461-2,499, so any edit to them failed CI (finding 333). Merge repeated statements and replace copies of detail owned elsewhere with links to the owning section. Headings and anchors are unchanged; no page is split. - flows/native-service-account-credential-delivery: 2,499 -> 2,299 - flows/workspace-files: 2,497 -> 2,299 - flows/harness-execution-topology: 2,493 -> 2,301 - guides/deploy/local-kubernetes-development: 2,490 -> 2,295 - guides/topics/agent-logs: 2,489 -> 2,294 - guides/deploy/production-installation: 2,461 -> 2,294 - contributing/console-storybook: 2,478 -> 2,298 Also name the Slack card buttons as the console renders them (Configure Slack, Edit Slack, Disable Slack) in the channels guide (finding 336).
- agent-logs: the editable draft is not a version; Kubernetes keeps nothing from deleted Pods. - workspace-files: API and worker Pods wait for the root Secret; local checks do not prove deployed acceptance. - native-service-account-credential-delivery: initial deployments use the same startup path as replacements. - console-storybook: models appear before credentials; reset to replay pending states before timeout. - harness-execution-topology: link the whole storage contract, since the claim sizes and teardown span both storage sections. - reference/cli: occ agent logs needs Agent read_logs or administer, as the API authorizes, not administer only.
Contributor
|
🦞👀 Pull request received. I will update this pull request when review starts. ClawSweeper review completeClawSweeper finished reviewing this revision. The review result is being finalized. |
Contributor
|
ClawSweeper status: review started. I am starting a fresh review of this pull request: docs: trim seven near-cap flow and guide pages under the word limit This is item 1/1 in the current shard. Shard 0/1. This temporary status tracks the active review worker. The completed review will appear in the durable ClawSweeper review comment. Crustacean status: shell secured, claws on keyboard, evidence pebbles being sorted. |
This was referenced Oct 8, 2026
This was referenced Oct 17, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
docs:check-lengthenforces a 2,500-word hard limit, and it was the most common CI failure on 2026-10-03. #1077 and #1078 trimmed ten at-cap pages. Fourteen more sat at 2,461-2,499 words, so almost any edit to them failed CI. This PR covers seven of them. The companion PR covers the other seven.The channels guide also named the Slack card buttons Configure, Edit and Disable, but the console renders Configure Slack, Edit Slack and Disable Slack (
apps/controller/src/console/channels/shared-ui.mjs).docs/flows/native-service-account-credential-delivery.mddocs/flows/workspace-files.mddocs/flows/harness-execution-topology.mddocs/guides/deploy/local-kubernetes-development.mddocs/guides/topics/agent-logs.mddocs/contributing/console-storybook.mddocs/guides/deploy/production-installation.mdChange
AGENTS.md. Each target section was checked to state the removed fact.docs/guides/concepts.mddefines. Proper names (OpenShell Gateway, Envoy Gateway, the Kubernetes Gateway API) keep their capitals.docs/guides/console/channels-and-credentials.md: use the rendered Slack button labels.docs/reference/cli.md:occ agent logsneeds Agentread_logsoradminister, as the API authorizes (getAgentDeploymentRuntimeLogs) and the logs guide and security reference already say, notadministeronly.docs/guides/topics/agent-logs.mdno longer says the CLI waits out429in general; the CLI reference (linked) says it waits only with--follow, which matchesinternal/occcli/cli.go.Verification
pnpm docs:checkon the combined state of both PRs: no page over the hard limit; 237 pages and 3,635 links validated; 76 spec documents validated.prettier --checkon the changed files: clean.shared-ui.mjsandtests/browser/console-agent-channels.test.mjs, which click Edit Slack and Disable Slack.AGENTS.md).Risks
Low; documentation only. Open PRs that also edit these pages may need a textual conflict resolution: #925, #913, #906, #884, #830, #662, #519, #489, #479, #307, #302, #299, #253 and #252.