Skip to content

Harden product documentation synchronization - #94

Merged
woksin merged 3 commits into
mainfrom
chore/harden-product-doc-sync
Sep 10, 2026
Merged

woksin merged 3 commits into
mainfrom
chore/harden-product-doc-sync

Conversation

@woksin

@woksin woksin commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

Summary

Harden the documentation aggregator against silent Markdown/MDX and navigation failures across product repositories.

Changed

  • Classify Components sections under explicit component-library and reference navigation buckets.
  • Preserve valid DocFX landing-plus-children navigation and resolve safe parent-relative targets.

Fixed

  • Reject ChronicleClientTabs in Markdown before they render as literal imports and inert elements.
  • Detect unknown Starlight asides, unsafe TOC structures, and generated Markdown imports with regression coverage.

Preserve Components navigation and nested DocFX toc links while rejecting Markdown-only MDX expansion. Add fence-aware lint guards for generated syntax errors and regression coverage for each conversion path.
Repository control files (AGENTS.md, CLAUDE.md, GEMINI.md) that live at
the product source root for tooling/AI setup are now excluded from the
generated documentation site, while preserving legitimate authored pages
with matching names elsewhere in the documentation tree.

Changed:
- Skip AGENTS.md, CLAUDE.md, and GEMINI.md at product.src root only.
- Preserve nested documentation pages named agents.md/claude.md/gemini.md.
- Apply exclusion to both primary product sources and familySources.
- Keep README.md exclusion behavior unchanged.

Fixed:
- Broken link from /contributing/agents/ to .cratis/PROJECT.md (private path).
- Product documentation sync no longer ingests repository bootstrap files.

Verified:
- All existing tests pass.
- New regression tests prove bootstrap exclusion at root and family sources.
- Nested agents.md/claude.md/gemini.md pages remain in generated docs.
- Link checker passes with 0 broken links (was 1).
- Build completes successfully.
- Private path protections remain intact.
@woksin
woksin merged commit ebf1b80 into main Sep 10, 2026
3 checks passed
@woksin
woksin deleted the chore/harden-product-doc-sync 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