docs: canonicalize AGENTS.md as the agent guide and freshen against code#49
Draft
jack-arturo wants to merge 3 commits into
Draft
docs: canonicalize AGENTS.md as the agent guide and freshen against code#49jack-arturo wants to merge 3 commits into
jack-arturo wants to merge 3 commits into
Conversation
Promote CLAUDE.md's content to AGENTS.md (canonical, read by all agents) and reduce CLAUDE.md to the bare `@AGENTS.md` import. Mechanical only; the freshness pass follows in the next commit. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
- Document the dual-server architecture: default profile-writer (profile_server.py, 7 tools + design_streamdeck_deck prompt) plus legacy USB server (server.py, 14 tools); old doc described only the USB server as the whole project. - Correct entry points (uv/uvx, not Node), real env var STREAMDECK_APP_PATH, and verified filesystem/state paths. - Generalize intro to coding agents (Claude Code, Cursor, Codex, others). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adopts the “agent-direction files” house standard by making AGENTS.md the canonical agent guide and reducing CLAUDE.md to a one-line import of @AGENTS.md, then refreshes the guidance to match the repository’s current dual-server architecture and tooling.
Changes:
- Canonicalized agent guidance: added
AGENTS.mdas the single source of truth and reducedCLAUDE.mdto@AGENTS.md. - Documented the current dual-server architecture (
profile_server.pyprofile-writer +server.pylegacy USB) including tool counts, entrypoints, and key paths/env vars.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
CLAUDE.md |
Replaced the prior guide with a one-line @AGENTS.md import per the house standard. |
AGENTS.md |
New canonical agent guide describing architecture, tools, entrypoints, and operational guidance aligned to the current codebase. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
… behavior Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What & why
Adopts the fleet house standard for agent-direction files:
AGENTS.mdis the single source of truth, andCLAUDE.mdis reduced to a one-line@AGENTS.mdimport. Claude Code resolves the import at launch; every other agent (Cursor, Codex, …) readsAGENTS.md's bytes directly. Token-neutral, and it kills the silent drift between near-identical copies.This repo had no prior
AGENTS.md, so there was no duplication to remove — this is adopting the standard (consistency + future-proofing across the fleet) plus a freshness pass against the current code. Reviewers should not hunt for a divergence that never existed.Two commits
docs: adopt house standard— purely mechanical:CLAUDE.md→@AGENTS.md, establish canonicalAGENTS.md, generalize the intro line to "coding agents (Claude Code, Cursor, Codex, …)".docs: freshen AGENTS.md against current code— every factual claim re-verified against source, withpath:linecitations.Freshness changes
profile_server.py— 7 tools + 1 prompt (design_streamdeck_deck).server.py— 14 tools.STREAMDECK_APP_PATH.The session's live tool list / README / published build exposes
streamdeck_read_plugins, butmain's source forprofile_server.pyregisters only 7 tools and does not include it. In other words, the source onmainlags the published build.AGENTS.mddocuments the source-of-truth state onmain(7 tools), not the published superset. Ifstreamdeck_read_pluginsis meant to ship, that's a code change for a separate PR — calling it out here so the doc isn't "corrected" back to an inaccurate count.Review note
Automated verification caught mechanical drift only — every tool/path/env-var named now exists in source, the counts match the code on
main,CLAUDE.mdis exactly@AGENTS.md. It does not judge whether the advice is still good or well-emphasized, and it deliberately documents source-mainover the published build (see caveat). Please read the diff for judgment. No auto-merge.🤖 Generated with Claude Code