Skip to content

Add Chronicle client-docs parity tooling and Kotlin/Elixir/TypeScript submodules#44

Open
woksin wants to merge 1 commit into
mainfrom
chore/chronicle-client-docs-parity
Open

Add Chronicle client-docs parity tooling and Kotlin/Elixir/TypeScript submodules#44
woksin wants to merge 1 commit into
mainfrom
chore/chronicle-client-docs-parity

Conversation

@woksin

@woksin woksin commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

Added

  • Chronicle.Kotlin, Chronicle.Elixir, and Chronicle.TypeScript as submodules, so their Documentation content participates in the shared multi-client Chronicle docs.
  • CI tooling that keeps shared Chronicle docs language-agnostic: an audit for direct client-language fences and legacy snippet placeholders (with a ratcheted baseline), and an aggregate check that verifies every listed client has a real, compiling snippet for each shared doc tab.

Fixed

  • web/.gitignore was missing an entry for the synced architecture/ docs content, unlike every other synced product folder — synced build output could get staged by accident.

Notes for reviewers

…r/TypeScript submodules

Adds the Kotlin, Elixir, and TypeScript Chronicle client repos as submodules
(their Documentation content now participates in the shared multi-client
docs), and the tooling that keeps the shared docs language-agnostic:

- web/scripts/audit-chronicle-client-docs.mjs — audits shared Chronicle docs
  for direct client-language fences (should be zero) and legacy snippet
  placeholders, with a ratcheted baseline.
- web/scripts/check-chronicle-client-docs.mjs — the aggregate CI check:
  runs the audit, verifies every listed client has a real snippet file for
  each shared tab, and runs each client's own compile-snippet validator.
- web/chronicle-client-docs.yml / chronicle-client-docs-baseline.json —
  config and the legacy-snippet-count ratchet.
- .ai/skills/chronicle-client-docs — the skill documenting this workflow.
- .ai/handoffs/ — session handoffs for the two migrations this tooling
  supports (eliminating legacy C# fences; widening to real Kotlin/Elixir/
  TypeScript parity), kept for continuity across sessions.

Also fixes a pre-existing gap where web/.gitignore listed every other synced
product doc folder except src/content/docs/architecture/, letting synced
build output get staged by accident.
@woksin woksin added the minor label Jul 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant