Skip to content

docs: raise console documentation to hyperscaler standard - #800

Merged
jason931225 merged 11 commits into
mainfrom
docs/hyperscaler-standard-2
Aug 19, 2026
Merged

docs: raise console documentation to hyperscaler standard#800
jason931225 merged 11 commits into
mainfrom
docs/hyperscaler-standard-2

Conversation

@jason931225

Copy link
Copy Markdown
Collaborator

Summary

Raise first-party docs to a hyperscaler reading standard: one live source of truth, current vs historical labeled, short pages, no aspirations as shipped. Docs-only. Does not fight open PR 796.

Verified 2026-08-17 findings against main at 7705578e and fixed what was still true:

  1. Verify / DotSlashREADME.md and docs/current/DELIVERY.md now share one new-clone sequence (npm ci, install DotSlash, export PATH, npm run verify). A clone without DotSlash on PATH fails Buck2-backed steps as environment errors.
  2. DESIGN.md / SPEC.md — tombstoned. They remain redirects to docs/current/PRODUCT.md so existing links resolve. They do not revive as architecture or spec authority.
  3. HANDOFF.md — restart pointer is live docs/current/* only. .omx/plans/reasoning-lens-contract-execution-handoff.json is explicitly not live authority.
  4. docs/DESIGN-DOCTRINE.md — collapsed to a banner plus the live frontend HOLD and ADR-0030 (with ADR-0025/0026 as historical).
  5. docs/CI-GATES.md — refreshed from package.json / .github/workflows/ci.yml. Inventory lists remain the machine-checked contract for check:foundation-gates.
  6. 69KB essay split — live inventory stays in docs/CI-GATES.md (~4KB). Historical per-gate prose moved to docs/program/ci-gates-historical-narrative.md (not a new top-level docs/*.md).
  7. docs/PLATFORM-ROADMAP.md — headings rewritten so a skim cannot dispatch pre-pivot work. Current order is only docs/current/ROADMAP.md.
  8. No new top-level docs/*.md.

Honest ADR-0020 note

ADR-0020 Verification names check:korean-institutional-connectivity. The script exists in package.json. No workflow invokes it. Open PR 796 records the same fact and leaves the script in place pending an ADR amendment. This PR does not delete or rewire that gate.

console-gate-vendor-lockin exists in-tree and is not in the CI-run inventory.

Test plan

  • npm run check:doc-manifest — OK (458 markdown files)
  • npm run check:doc-links — OK (458 markdown files)
  • npm run check:reasoning-lens-manifest — OK
  • git diff --check — clean
  • npm run check:foundation-gates after npm ci (local worktree lacked js-yaml; CI will run it)
  • Confirm docs/CI-GATES.md inventory headings still match ci.yml if that workflow moved after 7705578e

@jason931225 jason931225 left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Bars pass at 58e8923.

  • Existing owner files only. The extra docs/program/ci-gates-historical-narrative.md path is deleted and unseeded. Live inventory stays in docs/CI-GATES.md.
  • After edit: CI-GATES.md 78, DESIGN-DOCTRINE 12, PLATFORM-ROADMAP 45, DELIVERY 45, HANDOFF 16, DESIGN/SPEC tombstones 7. Manifests are existing inventory tables (unseed only).
  • One capability (raise console docs to one live source of truth)
  • No leftover new-path oya- name; net −1200 docs dump
  • No new required check or N+1 workflow

Not APPROVE. Hold until required CI is green.

@jason931225 jason931225 left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Bars pass at c27eca2 (rebased onto post-#796 main / eee8107).

  • Existing owner files only. Extra docs/program/ci-gates-historical-narrative.md still deleted and unseeded. Live inventory stays in docs/CI-GATES.md (78).
  • After edit: DESIGN-DOCTRINE 12, PLATFORM-ROADMAP 45, DELIVERY 45, HANDOFF 16, DESIGN/SPEC tombstones 7. No new top-level docs/*.md.
  • One capability (one live docs source of truth)
  • No leftover new-path name; net shrink vs base
  • No new required check. Merge from main only absorbs #796 unused-gate deletions.

Not APPROVE. Hold until required CI is green.

@jason931225
jason931225 force-pushed the docs/hyperscaler-standard-2 branch from c27eca2 to 15e3590 Compare August 18, 2026 12:16

@jason931225 jason931225 left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

PASS at 15e3590 (rebased onto current main 8b17bb9). Docs-only. Extra docs/program/ci-gates-historical-narrative.md still gone and unseeded. Live inventory stays in docs/CI-GATES.md (~78). Existing paths only; no new top-level docs/*.md; no new required check.

Bars checked: existing file, size, no third path, recorded shrink of the essay into history, docs-only. Inherited/old pin is not this PR. Not APPROVE.

jason931225 and others added 10 commits August 18, 2026 23:05
Drop the new docs/program/ci-gates-historical-narrative.md path. Live inventory stays here; the 69KB per-gate essay remains in git history at main:docs/CI-GATES.md.
`check:doc-manifest` and `check:doc-links` bind each entry to the exact Git
index-tree blob OID, not to file content, so both went red after the rebase:

  docs/documentation-manifest.seed.json: docs/CI-GATES.md blob_sha does not
  match the exact Git index-tree blob OID

Regenerated AFTER staging. Regenerating before staging computes OIDs the index
does not hold yet, passes locally, and fails in CI -- the same order-of-operations
that broke #807.

Verified: check:doc-manifest -> OK (457 files); check:doc-links -> OK (457);
check:doc-citations -> exit 0.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@jason931225
jason931225 force-pushed the docs/hyperscaler-standard-2 branch from 15e3590 to 746ee3b Compare August 19, 2026 03:06
@jason931225
jason931225 enabled auto-merge August 19, 2026 03:06
…ropped

`check:production-hardening` requires docs/CI-GATES.md to contain the exact
string

  CONSOLE_NETWORKPOLICY_PREFLIGHT=require npm run check:k8s:networkpolicy

Main carries it twice; the restructured inventory carried it zero times, so the
gate failed with "CI gates document required NetworkPolicy enforcement
preflight". That surfaced as a red "Trivy — IaC / manifest misconfig" job, which
is misleading: Trivy reported 0 misconfigurations across every target, and the
job died on the production-hardening step that runs after the render.

This is the gate working. `check:k8s` only RENDERS manifests and CI merely warns
when no live cluster is reachable; enforcement of the rendered NetworkPolicy is a
separate opt-in preflight. A deployment checklist that omits it reads as though
rendering were sufficient, which is why the string is pinned rather than left to
prose.

Restored as its own "Deployment gates" section rather than smuggled into a list,
and it says why the line is pinned so the next restructure does not drop it again.

Documentation manifest and index regenerated AFTER staging.

Verified: node scripts/check-production-hardening.mjs -> passed (239 checks);
check:doc-manifest -> OK (457); check:doc-links -> OK (457);
check:doc-citations -> exit 0.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@jason931225
jason931225 added this pull request to the merge queue Aug 19, 2026
Merged via the queue into main with commit ad1a107 Aug 19, 2026
27 checks passed
@jason931225
jason931225 deleted the docs/hyperscaler-standard-2 branch August 19, 2026 03:26
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