Skip to content

docs: refresh the guides against the code - #65

Merged
JLCode-tech merged 3 commits into
stagingfrom
docs/refresh
Sep 15, 2026
Merged

JLCode-tech merged 3 commits into
stagingfrom
docs/refresh

Conversation

@JLCode-tech

Copy link
Copy Markdown
Owner

What

Three audits of the documentation against the code, applied.

  • Counts and names. 41 phases everywhere (39 was pre metrics-server and tmm-log-stream). PHASES.md now lists the up flags, the down order including metrics-server, the phases with no down step, and describes preflight, forge-register, ebs-csi-hugepages, k8s-foundation and activation-poll as the code behaves (9-minute poll cap, no EULA check, no gp3 StorageClass).
  • Heal registry. README, COMMANDS, AGENTS, CLAUDE, CONTRIBUTING and ARCHITECTURE describe bnk heal (10 repairs after feat(heal): test-namespace repair; k8s backend runs Jobs without the ops pod #64), the doctor --backend k8s rows it feeds, and the awsbnkctl-test namespace test --backend k8s Jobs run in. CONTRIBUTING gains "Adding a Heal Repair" and the missing CI jobs and gosec gate.
  • Commands. COMMANDS.md and AGENTS.md carry the subcommands and flags that were missing (bnk heal/upgrade/migrate-2.4/mcp-session flags, forge scan/telemetry, benchmark ingest, targets scan, test dns/throughput/traffic flags). AWSBNKCTL_K8S_LONG_LIVED removed.
  • RELEASE.md rewritten: staging→main, squash titles for release-please, workflow_dispatch rebuild, make release gates, and the tools images that are actually published.
  • FORGE_INTEGRATION, UPGRADE-2.4, SCENARIOS, BGP-ROUTE-SERVER. Env-variable precedence, the AWSBNKCTL_FORGE_PROJECT purge caveat, link lifecycle commands, the full -o json field list, scenario assertions stated as the code makes them, no dated lab provenance.
  • Removed or reduced. docs/ALIGNMENT.md deleted (unreferenced cross-repo comparison). The Local Zones report is now a results table. The upstream issue has a status line.
  • Code help text. --skip-activation-poll says 9 min, test throughput no longer says "not yet implemented", k_aliases.go comment no longer claims a host-side exec command.

Depends on #64 for the tenth repair (test-namespace); merge #64 first.

🤖 Generated with Claude Code

JLCode-tech and others added 3 commits September 15, 2026 06:28
- 41 phases (not 39) everywhere; PHASES.md gains the up flags, the down
  order with metrics-server, the phases without a down step, and correct
  preflight, forge-register, ebs-csi, k8s-foundation and activation-poll
  descriptions (9-minute cap)
- ARCHITECTURE.md: SDK-only commitment covers client-go and the Helm SDK,
  cluster-side repairs section, honest state-recovery claim, full package
  table, manifestVersion in the example
- README/COMMANDS/AGENTS/CLAUDE: bnk heal and doctor rows, 10-repair
  registry, awsbnkctl-test Job namespace, missing flags and subcommands,
  VERSION=2.3.0, terse wording
- RELEASE.md rewritten: staging→main flow, squash titles, workflow_dispatch
  rebuild, make release gates, the tools images that are actually published
- FORGE_INTEGRATION, UPGRADE-2.4, SCENARIOS, BGP: corrected env precedence,
  purge caveat, link lifecycle, JSON fields, assertions as the code makes
  them, no dated lab provenance
- ALIGNMENT.md deleted; Local Zones report reduced to a results table;
  upstream issue gets a status line
- code help text: activation poll is 9 min, test throughput is implemented,
  k_aliases comment no longer claims a host-side exec command

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@JLCode-tech
JLCode-tech merged commit 3fe5af8 into staging Sep 15, 2026
13 checks passed
@JLCode-tech
JLCode-tech deleted the docs/refresh branch September 15, 2026 07:23
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.

1 participant