Skip to content

Improve canonical documentation authoring guidance - #298

Merged
woksin merged 9 commits into
mainfrom
chore/improve-documentation-guidance
Sep 10, 2026
Merged

woksin merged 9 commits into
mainfrom
chore/improve-documentation-guidance

Conversation

@woksin

@woksin woksin commented Sep 10, 2026

Copy link
Copy Markdown
Collaborator

Summary

Align canonical Cratis documentation guidance with the current multi-product Astro Starlight authoring and verification contracts.

Changed

  • Clarify generated-content ownership, product-specific navigation, Markdown/MDX boundaries, asides, components, routes, and rendering checks.
  • Improve documentation skills for authoring, editing, visual diagnosis, and correct framework examples.

Fixed

  • Correct stale Documentation checkout paths, universal bucket assumptions, invalid component imports, and extension-receiver guidance.

Use the reviewed Arc authoring evidence to align shared rules and skills with the current multi-product Starlight sync, rendering, navigation, and verification contracts.
Bind the revised documentation skills to c0a9255, record the reviewed Arc authoring evidence, and refresh generated catalog, projection, inventory, and accounting anchors.
Preserve canonical documentation guidance source commits while adopting
all newer origin/main changes. Regenerate catalogs and inventory from
merged sources.
Commit e635878 added the provenance field requirement and updated six of seven
S9 evidence reports, but s9-pi-attempt-3-current-2026-08-26.json was missed.
This completes the incomplete generation sequence:

- Add provenance: "runner" to s9-pi-attempt-3-current-2026-08-26.json
- Recompute reportPayloadDigest to reflect the new field
- Update catalog/evidence.json with the new file digest
- Update catalog/evidence-baseline.json with corrected digests for all seven
  S9 reports (the four preflight-blocked and three Pi attempt reports) to
  reflect their current state with provenance fields
- Update expectedEvidenceBaselineDigest in s10-release-gate-validation.mjs
  to match the corrected baseline

The S10 release gate and evidence baseline validation now pass.

Fixes a pre-existing incomplete generation from e635878 that left the baseline
anchored to file states before the provenance field was added.
The inventory index digest must reflect the corrected evidence baseline and
S9 report file digests.
…ove-documentation-guidance

Resolves conflicts in generated human catalog and repository inventory by:
1. Preserving canonical documentation guidance changes from c0a9255 and their evidence/catalog bindings
2. Adopting all origin/main S9 provenance fixes and newer facts from PR #296
3. Regenerating all required catalogs/artifacts using the documented pipeline:
   - node tooling/generate-human-catalog.mjs
   - node tooling/generate-repository-inventory.mjs

The resulting branch diff against origin/main excludes duplicate prerequisite fixes and contains only the documentation guidance changes plus their catalog bindings.
The shared-documentation-guidance-source-c0a9255 evidence brings the total
observation count from 183 to 184.
The inventory's indexDigest pins the tree's index blob shas, so it must be
the last generated artifact committed after any content change.
…tation-guidance

# Conflicts:
#	catalog/v2/repository-inventory.json
@woksin
woksin merged commit 4c55818 into main Sep 10, 2026
3 checks passed
@woksin
woksin deleted the chore/improve-documentation-guidance branch September 10, 2026 15:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant