docs: add hierarchical AGENTS knowledge base#1371
Open
YanzheL wants to merge 2 commits intoWei-Shaw:mainfrom
Open
docs: add hierarchical AGENTS knowledge base#1371YanzheL wants to merge 2 commits intoWei-Shaw:mainfrom
YanzheL wants to merge 2 commits intoWei-Shaw:mainfrom
Conversation
Capture repo-specific guidance at the root, backend, frontend, migrations, and Ent schema boundaries so future agents can navigate high-risk areas without duplicating instructions.
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.
Summary
deploy/AGENTS.mdfor Docker Compose, systemd, env-template, and deployment-script guidance that has distinct operational failure modesWhy this matters
This repo already has strong project-specific conventions, but they were split across READMEs, scripts, config files, and code comments. The AGENTS hierarchy is meant to make that guidance discoverable where an agent or contributor is actually working.
The important change in this update is scope discipline. Rather than proliferating AGENTS files for every large subtree, this branch keeps the hierarchy intentionally small and adds a child file only where the local failure modes are materially different.
deploy/meets that bar because deployment mistakes are operational, environment-specific, and easy to miss from code-oriented parent docs.What changed
Root
deploy/AGENTS.mdinstead of trying to keep deploy-specific rules in the root filetools/anddocs/Backend
backend/AGENTS.mdinternal/layout, includingconfig,domain,integration,middleware,model,pkg,testutil, andutilinternal/middleware/Backend migrations
_notx.sqlbehaviorBackend Ent schema
Frontend
src/router/,src/stores/,src/components/common/,src/components/layout/, andsrc/views/auth/Deploy
Deliberate design choices
backend/internal/service,backend/internal/repository,backend/internal/handler/admin, or frontend subtrees because current evidence points to shared parent rules and existing local READMEs, not separate instruction contractsValidation
git diff --check