Skip to content

docs: align 40 docs with main after the week of 2026-11-14 - #37935

Merged
iamwhatever merged 2 commits into
mainfrom
docs/dockeeper-weekly-2026-11-16
Nov 16, 2026
Merged

iamwhatever merged 2 commits into
mainfrom
docs/dockeeper-weekly-2026-11-16

Conversation

@iamwhatever

@iamwhatever iamwhatever commented Nov 16, 2026 •

Copy link
Copy Markdown
Contributor

Problem / Motivation

Goal: Make the docs say what the code on main does after the 304 commits that landed between b81cf5a3ac (2026-11-14) and 5abc52be3a.

Those commits renamed classes, moved owners, changed defaults and added CLI flags, config keys and preview names. About forty docs still described the old code or left the new parts out.

Why it matters

People and agents read these docs before they touch the code. AGENTS.md sends every session to the owning spec first, so a stale owner table or a missing flag sends them the wrong way.

Not a goal

  • No code, test or baseline change.
  • No edit to docs/decisions/ (byte-immutable). No drift was found there.
  • RFC proposal text is untouched; only status lines, front matter status and index rows move.
  • Not a cut of the pre-existing report-only dead identifiers.

What changed (motivation → approach → change)

Each behaviour commit in the range was read against the docs that name its module, tool, flag, key or route. A doc was fixed only where the current code says otherwise.

Area Docs What was wrong
CLI cli.md No rows for remote-control status/on/off or workspace list/delete; the eval row lacked --baseline, --max-drop, --junit
ACP client acp-client.md, side.md, model-selection.md, agent-host-contract.md, harness-gap-analysis.md, harness-onboarding.md, error-handling.md Per-backend client classes (ClaudeAcpClient, GooseAcpClient, OpencodeAcpClient, DeepseekAcpClient) and their owner modules were missing; moved methods and tripwires pointed at old homes; new rate-limit wording was undocumented
Config and previews config.md, configuration.md, snapshot-and-restore.md config.md named SessionAllocation for SessionAllocationService; preview names list lacked bridge_approvals, secrets_vault, worker_grill; no row for dashboard.channels_enabled; import size limits and rebuildable folders left out
Security and governance security.md, governance.md, meetings.md, auto-improvement.md Windows program suffixes and in-word escapes; policy validate on an unlistable profiles dir; sketch frame CSP now hash-pinned; clone identity pin
Monitor, ledger, Bots monitor-architecture.md, monitor-loops.md, crew-log-projection.md, session-control.md, crew-members.md, app-notifications.md Final turn when a watched PR merges; needs_you rule; per-Bot worker cap; Goals tab credits card; bot_limits_held note
Dashboard, metrics, apps metrics.md, learn-cron-dashboard.md, dashboard.md, api-reference.md, browser.md, knowledge.md, kas-auth.md, remote-crew.md, feature-map/README.md Privacy notice version, Privacy chapter close, spend by model grouping, Spend recommendations, [GRILL:] marker, browser change report, eval tool assertions, knowledge ignore caps, SSO start URL, Shared Crews card
Install install.md, docker.md, windows-install.md, e2e-gate.md otlp extra, newer container image on About, installer clearing too-deep files
Memory records memory-skills-hooks.md Described record-list filters (applies, source, status, never_recalled), a status-widened refresh and the unforget / set_tier bulk operations that the records and bulk handlers on main do not accept (they are in the open #37498)
RFC status rfc-reroute-first-ask-policy.md, rfc-work-ledger-resource-pressure.md, rfc-crew-api.md, rfc-crewmate-workers-under-the-crewmate.md, request-for-change/README.md Two RFCs whose PRs merged (#37609, #37164) move to implemented; rfc-crew-api moves to partial since #34104 serves the owner roster; the crewmate RFC no longer cites a retired preview

Backwards compatibility

Compatible: docs only; nothing that works today stops working.

Removes nothing: the diff only corrects or adds prose and table rows.

Tests

Proof: not provable -- docs or config only

  • python3 scripts/docs_lint.py exits 0; report-only dead identifiers went from 605 to 601.
  • bash scripts/docs-lint.sh exits 0.
  • 88 test files that name a changed doc: 3190 passed, 25 skipped.
  • scripts/check_brand_name.py passes on the added lines.

Manual verification

Each changed claim was checked against the code at 5abc52be3a.

Related Issues

N/A — weekly docs-vs-code check, no tracking issue.

Checklist

  • At most two commits (one is the norm), with a Conventional Commits title (feat|fix|docs|style|refactor|perf|test|chore|ci|build|revert: ...)
  • Existing tests pass and new tests added for new functionality
  • Self-review completed; code follows project style guidelines
  • Documentation updated (if applicable)
  • No secrets, credentials, or internal references in the diff

Contribution License Agreement

Contributions are accepted under the project's Apache-2.0 license.

@iamwhatever
iamwhatever requested review from a team and KiroCrewCaptain as code owners November 16, 2026 10:24
@github-actions github-actions Bot added the readiness: checking Automated validation is still running label Nov 16, 2026
@github-actions

github-actions Bot commented Nov 16, 2026 •

Copy link
Copy Markdown
Contributor

UX Review (Opus 5.5) — ⏭️ skipped

Revision 85d87019d37075a095a86e3d4aa3ad1d2b0f0eb7 touches no user-facing surface (no changes under website/ or committed screenshots), so the UX review was skipped. Does not block merge.

@github-actions

github-actions Bot commented Nov 16, 2026 •

Copy link
Copy Markdown
Contributor

Design Review (Opus 5.5) — ✅ PASS

Design-level review of 85d87019d37075a095a86e3d4aa3ad1d2b0f0eb7 — updated in place on each push. A BLOCK verdict blocks PR readiness; PASS does not.

Design-Verdict: PASS

Docs-only change that brings the specs back in line with main; no code, contract or persisted data moves, so nothing blocks.

[DESIGN-REVIEWED] 85d8701

Description read

[DESCRIPTION-READ] bcb5e5b48c78a08fe0544c053ea09f8be5541b9e82c7a3987192677b7640702a

That sha256 names everything this verdict read: the PR description, plus the 1 evidence file(s) the workflow collected from it and handed this review. It covers that evidence because the media strip replaces every attachment URL with the same placeholder, so an edit swapping one attachment for another would leave the description's captured text identical while what this review judged changed. Recompute it with .github/scripts/pr-description-capture.sh over the same inputs; if it differs, the description or that evidence changed after this verdict was formed and any finding drawn from either is unproven.

@github-actions

github-actions Bot commented Nov 16, 2026 •

Copy link
Copy Markdown
Contributor

First Principles Review (Opus 5.5) — ✅ PASS

Premise-level review of 85d87019d37075a095a86e3d4aa3ad1d2b0f0eb7 — why this exists and whether the shipped surface is the smallest honest version. Updated in place on each push. A BLOCK verdict blocks PR readiness; PASS does not.

First-Principles-Verdict: PASS

This PR changes only docs, and each edit brings a doc in line with code already on main. No item changes a product default.

What this change ships

Inventory (10 items) — 10 justified

Intent: make the docs say what main's code does after a week of merges. This is a FIX (docs drift).

  1. The CLI spec gains rows for the remote-control and workspace commands and the new eval flags — justified
  2. The ACP client spec documents the per-backend client classes and their owner modules, and fixes old method homes — justified
  3. The config and preview docs fix the SessionAllocationService name, add the missing preview names and add a dashboard.channels_enabled row — justified
  4. The memory spec drops record filters and bulk operations that the handlers don't accept (0 hits for never_recalled|set_tier|unforget in src/kiro_crew) — justified
  5. Two RFCs move to implemented, citing their merged PRs — justified
  6. rfc-crew-api moves to partial because feat: serve the bot roster on the crew api owner route #34104 already serves the owner roster route — justified
  7. The crewmate RFC now says feat(members): hide a Bot's sessions from the session list by default #37713 retired the preview — justified
  8. The Windows install and e2e docs describe the installer's handling of files too deep to move, and its exit-code-2 stop — justified
  9. The Docker and install guides describe the About page's container update notice and the otlp extra as kept for compatibility — justified
  10. The error-handling and harness docs document the per-user rate-limit wording and the renamed opencode refusal symbol — justified

[FIRST-PRINCIPLES-REVIEWED] 85d8701

Description read

[DESCRIPTION-READ] 09663bf9d42c3ea7050f8d6c5c20ed6b185b8b261012917f9e11a4ad2cb3112f

That sha256 names the PR description this verdict read. Recompute it with .github/scripts/pr-description-capture.sh; if it differs, the description changed after this verdict was formed and any finding drawn from the description is unproven.

@github-actions

github-actions Bot commented Nov 16, 2026 •

Copy link
Copy Markdown
Contributor

Opus 5.5 Review — ✅ no blocking findings

Reviewed 85d87019d37075a095a86e3d4aa3ad1d2b0f0eb7 — this comment is updated in place on each push.

Review details

No findings.

[OPUS-REVIEWED] 85d8701

Verdict parsed from the review's SHA-scoped output markers for commit 85d87019d37075a095a86e3d4aa3ad1d2b0f0eb7.

False positive or not applicable? A repository writer can comment:
/ai-review override fable 85d87019d37075a095a86e3d4aa3ad1d2b0f0eb7 false-positive: <reason, 20 to 500 characters>

@github-actions

github-actions Bot commented Nov 16, 2026 •

Copy link
Copy Markdown
Contributor

GPT 6.1 Review — ✅ no blocking findings

GPT 6.1 completed its review of 85d87019d37075a095a86e3d4aa3ad1d2b0f0eb7 and found no blocking issues.

This comment is updated in place on each push.

Review details

No findings.
[GPT-REVIEWED] 85d8701

False positive or not applicable? A repository writer can comment:
/ai-review override gpt 85d87019d37075a095a86e3d4aa3ad1d2b0f0eb7 false-positive: <reason, 20 to 500 characters>

@iamwhatever

iamwhatever commented Nov 16, 2026 •

Copy link
Copy Markdown
Contributor Author
  • span=7d22c553fd6a Preserve access to a resumed chat's recorded scratch directory

Rebutted: not applicable to this PR. git diff origin/main...HEAD --stat lists only .md files; src/kiro_crew/providers/chat_share.py is untouched, and the join at :927-955 with its "is not mounted" warning is on main as-is.
The docs here describe that shipped behaviour and add no code path, so no change in this PR can fix or worsen it. The lane passed on the later heads e340f60 and 85d8701.

@iamwhatever
iamwhatever force-pushed the docs/dockeeper-weekly-2026-11-16 branch from b434f3c to 87fe067 Compare November 16, 2026 12:33
@github-actions github-actions Bot added readiness: action required A blocking check or review needs attention and removed readiness: checking Automated validation is still running labels Nov 16, 2026
@iamwhatever
iamwhatever force-pushed the docs/dockeeper-weekly-2026-11-16 branch from 87fe067 to e340f60 Compare November 16, 2026 13:05
zejiangg added 2 commits November 16, 2026 14:06
Weekly docs-vs-code check of the 304 non-merge commits between
b81cf5a and 5abc52b. Fixes stale owners, renamed classes,
changed defaults and flags, adds rows for CLI subcommands, config
keys and preview names that had none, and moves three RFC status
lines to match what merged.
The memory spec described record-list filters (applies, source,
status, never_recalled), a status-widened refresh and the unforget
and set_tier bulk operations. None of them is in the records or bulk
handlers on main; they belong to the open #37498. The config spec
named SessionAllocation, whose class is SessionAllocationService.
The runtime-ownership paragraph on a restart rejoin is dropped, since
#37826 removed join_on_tree and _join_own_tree.
@iamwhatever
iamwhatever force-pushed the docs/dockeeper-weekly-2026-11-16 branch from e340f60 to 85d8701 Compare November 16, 2026 14:07
@github-actions github-actions Bot added readiness: passed Eligible automated validation passed for the current revision and removed readiness: action required A blocking check or review needs attention labels Nov 16, 2026
@iamwhatever
iamwhatever enabled auto-merge (squash) November 16, 2026 15:19
@KiroCrewCaptain

Copy link
Copy Markdown
Collaborator

Code change approver recommendation: Approve

Why: the decider estimates a 10% chance that this change introduces a defect, within the 12% limit for approving on its own, and every check passes.

This PR changes docs only, to bring them in line with main. I spot-checked about 30 cited symbols, constants and limits and all of them match the code. That covers the Windows deny-gate helpers, rm_floor._RM_WORDS, the import size limits, BOT_MAX_WORKERS_MAX=32, browser change-report budgets, clone identity, monitor terminal wake, the user-rate-limit text, privacy notice version 3, channels_enabled default false, the otlp base dependency at the same pin, and the /v1/crew/owner/bots route. Removing the memory-record filters and the unforget/set_tier operations is correct: no source under src/ mentions them. The RFC status moves are backed by merged PRs, as in the earlier audit wave; nothing touches docs/decisions/ and no trust boundary moves. The only gap is that acp-client.md leaves out MimocodeAcpClient. That is incomplete documentation with no behavioural effect, so it does not block.

An automated recommendation, not a review: a maintainer still decides. It approves on its own only when the estimated chance of a defect is at most 12% and the change has at most 400 changed lines. Decider v3c (217fe607) · commit 85d87019d3 · 300 changed lines. If this recommendation is wrong, reply here: replies are how the approver is evaluated.

@KiroCrewCaptain KiroCrewCaptain left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This review checked the doc claims on this head against the code on main. All changed .py paths resolve. The new client classes, SessionAllocationService and the FEATURE_PREVIEW_FLAGS list all match. So do the import size limits (2 GiB, 100, 64 GiB, 1 GiB), the Windows deny-gate helpers, the policy validate exit behaviour and the meetings CSP. The RFC status moves cite PRs that are merged (#37609, #37164, #34104). The PR touches no code, tests or baselines.

Well done: the memory-skills-hooks.md cut removes record filters and bulk operations that main's records handler refuses. It also points to #37498, the open PR where that code lives.

The design is signed off under the standing maintainer sign-off for changes by team members.

Optional:

  • docs/system-specs/modules/config.md:1649 and src/kiro_crew/docs/snapshot-and-restore.md:321 say every import refusal names the biggest folders. Only the 64 GiB ceiling and free-disk refusals do. The per-file and zip-bomb ratio messages do not.
  • docs/system-specs/modules/acp-client.md:67 lists four AcpClient subclasses. MimocodeAcpClient (acp/client_mimocode.py) is already in this PR's base and is missing.
  • docs/request-for-change/README.md:62 says #34104 built GET /v1/crew/owner/bots, then says the only versioned route is POST /v1/chat/completions at 4e605b0d2b. The last-audited and audited-at fields in the three RFCs whose status moved still show the older audit.

@iamwhatever
iamwhatever merged commit 57f7678 into main Nov 16, 2026
99 checks passed
@iamwhatever
iamwhatever deleted the docs/dockeeper-weekly-2026-11-16 branch November 16, 2026 15:39
@github-actions github-actions Bot removed the readiness: passed Eligible automated validation passed for the current revision label Nov 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants