site index Source Ownership
site index Source Ownership
This file defines source ownership for generated site/index.md.
Scope
- Source directory:
site/src/ - Generated output:
site/index.md - Generator action:
npm run objc3c -- build-site
Source Ownership Matrix
| Source file | Responsibility | Primary owner | Backup owner |
|---|---|---|---|
index.contract.json |
Generator contract, canonical input/output paths, front matter | compiler/docs | compiler/tooling |
index.body.md |
Curated public-facing site content and stable public anchors | compiler/docs | spec/maintainers |
README.md |
Generated-only policy and contributor guidance | compiler/docs | compiler/release |
Update Workflow
- Update
site/src/index.contract.jsononly when generator contract changes. - Update the curated site content under
site/src/index.body.mdas needed. - Run
npm run objc3c -- build-siteto regeneratesite/index.md. - Run
npm run objc3c -- check-siteand require pass.
Review Policy
- Direct changes to
site/index.mdmust match owner-input updates and regeneration evidence. - Contract or policy changes in
site/src/*requirecompiler/docsreview. - Anchor or status-model changes in
site/src/index.body.mdrequirecompiler/docsreview. - PR description must include regeneration command and drift-check result.
- Command examples must use the public npm action surface,
npm run objc3c -- <action>, and must not introduce retired package-script names. - Capability status changes must cite
docs/support/capability_matrix.*,docs/support/evidence_map.md, anddocs/support/capability_claim_responsibility.md.
Generated Surface Boundary
Treat these as the live documentation-generation surfaces:
- human-facing generated site:
site/src/index.body.mdsite/src/index.contract.jsonnpm run objc3c -- build-sitesite/index.md
- human-facing generated native implementation doc:
docs/objc3c-native/src/*.mdnpm run objc3c -- build-native-docsdocs/objc3c-native.md
- machine-facing generated operator appendix:
package.json- public npm action surface:
npm run objc3c -- <action> - action catalog:
scripts/objc3c_workflow/action_catalog.py npm run objc3c -- build-public-command-surfacedocs/runbooks/objc3c_public_command_surface.md
Generated report and artifact directories remain transient output roots, not documentation owner inputs.