HYPERFLEET-930 - docs: replace CLAUDE.md with AGENTS.md#146
Conversation
…agent guidelines CLAUDE.md was a verbose mix of human workflow and agent instructions. AGENTS.md is agent-only: project context, document routing, format rules, validation, gotchas, and boundaries. CLAUDE.md now imports AGENTS.md via @-reference. Also fixes stale note in components/CLAUDE.md about sentinel.md lacking Trade-offs sections.
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
📝 WalkthroughWalkthroughThis PR establishes centralized documentation governance for the HyperFleet architecture repository. A new AGENTS.md file defines the repository's documentation-only scope, required validation tooling (markdown, YAML, link checks), source-of-truth mappings by doc type, metadata and section requirements, and explicit contributor boundaries. The existing CLAUDE.md is consolidated from a full guidelines document into a single reference to AGENTS.md. A component-level documentation reference is updated to point to sentinel.md as a pattern example. Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@AGENTS.md`:
- Around line 1-4: Add the required YAML front-matter header at the very top of
AGENTS.md containing the fields "Status", "Owner", and "Last Updated"
(YYYY-MM-DD); ensure the header is enclosed in triple-dashes --- at start and
end, e.g. include Status: <value>, Owner: <name or team>, Last Updated:
<YYYY-MM-DD>, and place it before any other content so the document complies
with the doc-governance contract.
In `@CLAUDE.md`:
- Line 1: CLAUDE.md currently points to AGENTS.md but is missing the required
metadata header; add a top-of-file metadata block containing the fields
"Status:", "Owner:", and "Last Updated:" (with appropriate values) so the
document conforms to the guideline that every document—even pointer/alias
files—must include the mandatory metadata header; update CLAUDE.md (the pointer
file) to include these three fields as the first lines.
🪄 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: Central YAML (base), Organization UI (inherited)
Review profile: ASSERTIVE
Plan: Enterprise
Run ID: 6d69537f-d14e-4ddf-a205-1e547d30f76c
📒 Files selected for processing (3)
AGENTS.mdCLAUDE.mdhyperfleet/components/CLAUDE.md
CLAUDE.md was a verbose mix of human workflow and agent instructions. AGENTS.md is agent-only: project context, document routing, format rules, validation, gotchas, and boundaries. CLAUDE.md now imports AGENTS.md via @-reference. Also fixes stale note in components/CLAUDE.md about sentinel.md lacking Trade-offs sections.
Summary
Test Plan
make test-allpassesmake lintpassesmake test-helm(if applicable)