Skip to content

docs: expose ADRs and consumer guidance as enchiridion snippets - #7023

Draft
ckychris wants to merge 1 commit into
mainfrom
docs/enchiridion-adr-snippets
Draft

docs: expose ADRs and consumer guidance as enchiridion snippets#7023
ckychris wants to merge 1 commit into
mainfrom
docs/enchiridion-adr-snippets

Conversation

@ckychris

Copy link
Copy Markdown
Contributor

Objective

Our ADRs and agent guidance aren't discoverable through the cultureamp-docs MCP, so agents working in consumer repos can't find kaizen's UI/design decisions. Confirmed in Slack that this needs no enchiridion change, only a folder_paths addition here. Adds ADR 0006 (no animation or interaction before dependent data is ready) so the first regeneration proves the pipeline on a real decision.

Scope is deliberately the decisions plus the two docs a consumer needs when writing kaizen code. Proposals, reports and lsp-vs-grep stay out — they're internal to our team.

Decisions

  • Kept the whole adr/ directory in folder_paths rather than listing files. Cost: template.md becomes a snippet, so an agent can retrieve an empty ADR template. Enchiridion has no per-file exclude within a directory, and listing files means a config line per new ADR. (Decision: Chris.)
  • ADR 0006 is marked Proposed, not Accepted. Wording isn't agreed with the team yet, so it lands as a draft position for review here.
  • Docs attached to @kaizen/components only, though ADR 0001 also covers tokens. Deferred splitting them across packages until we see how the snippets read.

Verifications

  • Read enchiridion's file_tree source: .md is a supported type, folder_paths accepts individual files as well as directories, and none of these paths hit SKIP_FILES/SKIP_DIRS.
  • Snippets won't exist until a docs regeneration runs (on release, or manual workflow_dispatch). Not verified end to end.

🤖 Generated with Claude Code

- Kept the whole adr/ directory rather than listing files, so template.md ships as a snippet too; per-file excludes aren't supported inside a directory
- ADR 0006 marked Proposed, not Accepted, since the wording isn't agreed with the team yet

Co-Authored-By: Claude <noreply@anthropic.com>
@pip-the-concierge

Copy link
Copy Markdown
Contributor

🛎️ Concierge

  • PR Review — AI-powered code review

@changeset-bot

changeset-bot Bot commented Aug 14, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: abd235d

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

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