Skip to content

docs: audit and update CLAUDE.md + BOOKMARKS.md#1292

Merged
jeremyeder merged 5 commits intoambient-code:mainfrom
jeremyeder:docs/claude-md-audit
Apr 11, 2026
Merged

docs: audit and update CLAUDE.md + BOOKMARKS.md#1292
jeremyeder merged 5 commits intoambient-code:mainfrom
jeremyeder:docs/claude-md-audit

Conversation

@jeremyeder
Copy link
Copy Markdown
Contributor

@jeremyeder jeremyeder commented Apr 11, 2026

Summary

  • CLAUDE.md: Add 3 missing components to Structure, 3 Makefile targets, strip stale test counts, establish convention authority hierarchy (CLAUDE.md wins over constitution for shared conventions)
  • BOOKMARKS.md: Add Governance section (constitutions + SDD preflight), ADR-0007, 3 component guides, OpenShift dev guide, 3 design docs
  • All 62 existing links verified — zero broken references

Test plan

  • Verify all newly-added paths exist in the repo
  • Confirm BOOKMARKS.md TOC anchors resolve correctly
  • Review convention authority language for clarity

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added a Governance section linking constitutions and CI workflow
    • Declared CLAUDE/BOOKMARKS as convention authorities and updated precedence rules
    • Added an ADR for workspace-scoped feature-flag management
    • Converted many guide sections into table-based listings and added new component guides (ambient API, SDK, CLI, OpenWebUI)
    • Expanded design/planning docs for runtime registry, CLI runners, and status updates
    • Updated local development guidance for OpenShift and simplified pre-commit/test documentation
    • Bumped constitution metadata and added a v1.1.0 changelog

CLAUDE.md: add 3 missing components (ambient-api-server, ambient-sdk,
open-webui-llm), 3 Makefile targets (kind-rebuild, kind-login,
dev-bootstrap), strip stale test counts, establish convention authority
hierarchy (CLAUDE.md > constitution for shared conventions).

BOOKMARKS.md: add Governance section (ACP Constitution, Runner
Constitution, SDD Preflight), ADR-0007, 3 component guides, OpenShift
dev guide, 3 design docs.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 11, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: dbd1e918-ad49-4a52-87a5-1fca8ab5ac94

📥 Commits

Reviewing files that changed from the base of the PR and between a8eb5b4 and e92d620.

📒 Files selected for processing (3)
  • .specify/memory/constitution.md
  • BOOKMARKS.md
  • CLAUDE.md
🚧 Files skipped from review as they are similar to previous changes (2)
  • .specify/memory/constitution.md
  • CLAUDE.md

📝 Walkthrough

Walkthrough

Documentation-only updates across project guides and governance: added Governance links and new ADR/component/design guides in BOOKMARKS.md; expanded CLAUDE.md with component entries, make targets, and a Convention Authority section; bumped and revised the constitution at .specify/memory/constitution.md (version, authority, and compliance guidance changes).

Changes

Cohort / File(s) Summary
Bookmarks / Docs
BOOKMARKS.md
Inserted a Governance section (links to ACP Constitution, Runner Constitution, SDD Preflight CI); added ADR-0007 (Unleash feature flags with workspace-scoped overrides); added Component Guides for ambient API server, SDK, and ambient CLI; added OpenShift local dev guide; added design/planning docs for Agent Runtime Registry, CLI Runners, and Status Update Comparison.
Project Overview
CLAUDE.md
Added components: components/ambient-api-server/, components/ambient-sdk/, components/open-webui-llm/; added make targets kind-rebuild, kind-login, dev-bootstrap; removed numeric test annotations; added a Convention Authority section naming CLAUDE.md and BOOKMARKS.md as authoritative for shared conventions.
Constitution / Governance
.specify/memory/constitution.md
Bumped version to v1.1.0 and updated last-updated date; removed in-file per-language development standards, naming/migration sections, pre-deploy validation commands, and container security bullets in favor of delegating those concerns to /CLAUDE.md and /BOOKMARKS.md; simplified Production Requirements; replaced “Constitution supersedes” rule with an Authority section deferring convention precedence to CLAUDE.md and BOOKMARKS.md; narrowed compliance bullets and removed pre-commit checklist enforcement.
🚥 Pre-merge checks | ✅ 6
✅ Passed checks (6 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed Title follows Conventional Commits format (docs: scope) and accurately summarizes the main changes: auditing and updating documentation files CLAUDE.md and BOOKMARKS.md.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Performance And Algorithmic Complexity ✅ Passed PR modifies only documentation files with no executable code changes; no performance or algorithmic complexity concerns.
Security And Secret Handling ✅ Passed PR contains documentation-only changes to three markdown files with no code modifications. Security pattern search confirms no plaintext secrets, tokens, credentials, or API keys present.
Kubernetes Resource Safety ✅ Passed PR modifies only markdown documentation (BOOKMARKS.md, CLAUDE.md, constitution.md); no Kubernetes manifests or resource definitions present.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
✨ Simplify code
  • Create PR with simplified code

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@CLAUDE.md`:
- Line 157: The two documents conflict on governance precedence; update them to
a single authoritative source by choosing one rule (prefer making
.specify/memory/constitution.md the superseding authority) and align both files:
change the sentence in CLAUDE.md (the line that currently says "If they
conflict, this file wins.") to state that the ACP Constitution
(.specify/memory/constitution.md) takes precedence in conflicts, and also edit
.specify/memory/constitution.md to explicitly assert the same precedence
language so both files match exactly; ensure any references to BOOKMARKS.md
remain consistent with the chosen precedence.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 7f7e0798-7f04-408d-ae56-b7bbbafb67b7

📥 Commits

Reviewing files that changed from the base of the PR and between 5e5f584 and f6abc18.

📒 Files selected for processing (2)
  • BOOKMARKS.md
  • CLAUDE.md

jeremyeder and others added 2 commits April 10, 2026 23:11
Updated API Server Guide link to point to GitHub repository.
Drop duplicated Development Standards (Go, Frontend, Python, Naming)
and Pre-Deployment Validation from the constitution — these are now
maintained in CLAUDE.md and BOOKMARKS.md as the single source of truth.

Add Authority section to Governance establishing that CLAUDE.md wins
on conflicts with shared conventions. Remove "supersedes all" language.

Resolves CodeRabbit review comment on precedence contradiction.

Constitution version bumped: 1.0.0 → 1.1.0

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (2)
.specify/memory/constitution.md (2)

298-302: Consider defining "spec-kit-governed concerns" explicitly.

The term "spec-kit-governed concerns" is inferable from the Authority section (lines 294-296: principles, commit discipline, amendment process), but could be more explicit for new contributors.

Optional: Explicit scope definition
 ### Compliance
 
-- All pull requests MUST verify constitution compliance for spec-kit-governed concerns
+- All pull requests MUST verify constitution compliance for spec-kit-governed concerns (core principles I-X, commit discipline thresholds, amendment process)
 - Complexity violations MUST be justified in implementation plans

This makes the compliance scope self-evident without requiring cross-reference to Authority section.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.specify/memory/constitution.md around lines 298 - 302, Add an explicit
definition for the phrase "spec-kit-governed concerns" in the Constitution near
the Compliance section: insert a short sentence or a new "Scope" sub-bullet that
lists what falls under spec-kit governance (e.g., repository structure,
contribution rules, release process, security and licensing policies, CI/CD
configuration, and amendment procedures) so readers can understand the
compliance boundary without cross-referencing the Authority section; update the
"Compliance" heading text to reference this new scoped definition and ensure the
exact phrase "spec-kit-governed concerns" is defined verbatim.

294-296: LGTM: Authority hierarchy clearly established.

The new section successfully limits constitution scope to spec-kit governance while deferring conventions to CLAUDE.md/BOOKMARKS.md. The precedence rule "CLAUDE.md wins" is consistent with CLAUDE.md's own Convention Authority section.

Optional: Clarify the three-tier precedence chain

For maximum clarity, could explicitly state the full precedence hierarchy:

-[`/CLAUDE.md`](/CLAUDE.md) and [`/BOOKMARKS.md`](/BOOKMARKS.md) are the authoritative source of project conventions. This constitution covers spec-kit-specific governance (principles, commit discipline, amendment process) and defers to those files for shared conventions. If they conflict, CLAUDE.md wins.
+[`/CLAUDE.md`](/CLAUDE.md) and [`/BOOKMARKS.md`](/BOOKMARKS.md) are the authoritative source of project conventions. This constitution covers spec-kit-specific governance (principles, commit discipline, amendment process) and defers to those files for shared conventions. Precedence for conflicts: CLAUDE.md > BOOKMARKS.md > Constitution.

However, the current wording is sufficiently precise.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.specify/memory/constitution.md around lines 294 - 296, Update the
"Authority" section to explicitly state the precedence chain so it's
unambiguous: add a single sentence listing the three-tier order (e.g.,
"Precedence: CLAUDE.md > BOOKMARKS.md > this constitution") and keep the
existing text that defers to /CLAUDE.md and /BOOKMARKS.md and the phrase
"CLAUDE.md wins"; edit the Authority heading and lines referencing `/CLAUDE.md`
and `/BOOKMARKS.md` to include that one-line precedence statement.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In @.specify/memory/constitution.md:
- Around line 298-302: Add an explicit definition for the phrase
"spec-kit-governed concerns" in the Constitution near the Compliance section:
insert a short sentence or a new "Scope" sub-bullet that lists what falls under
spec-kit governance (e.g., repository structure, contribution rules, release
process, security and licensing policies, CI/CD configuration, and amendment
procedures) so readers can understand the compliance boundary without
cross-referencing the Authority section; update the "Compliance" heading text to
reference this new scoped definition and ensure the exact phrase
"spec-kit-governed concerns" is defined verbatim.
- Around line 294-296: Update the "Authority" section to explicitly state the
precedence chain so it's unambiguous: add a single sentence listing the
three-tier order (e.g., "Precedence: CLAUDE.md > BOOKMARKS.md > this
constitution") and keep the existing text that defers to /CLAUDE.md and
/BOOKMARKS.md and the phrase "CLAUDE.md wins"; edit the Authority heading and
lines referencing `/CLAUDE.md` and `/BOOKMARKS.md` to include that one-line
precedence statement.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 8d0052b9-f672-45bd-828d-40149d146ced

📥 Commits

Reviewing files that changed from the base of the PR and between 5611db8 and a8eb5b4.

📒 Files selected for processing (1)
  • .specify/memory/constitution.md

Ambient Code Bot and others added 2 commits April 10, 2026 23:19
CLAUDE.md: compress pre-commit hooks section from 48 to 5 lines (config
file is source of truth), merge Convention Authority + More Info.

BOOKMARKS.md: convert H3+description format to tables (-136 lines),
merge duplicate CRC/OpenShift entries into one.

Constitution: replace duplicated implementation details in Principles
II, III, VII with cross-references to CLAUDE.md Critical Context and
pattern files. Keeps principle statements and rationale intact.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@jeremyeder jeremyeder enabled auto-merge (squash) April 11, 2026 03:27
@jeremyeder jeremyeder disabled auto-merge April 11, 2026 03:34
@jeremyeder jeremyeder merged commit 8a2310a into ambient-code:main Apr 11, 2026
8 checks passed
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