Repository navigation
Agent docs: table routing, vocabulary by area, persisted-data checklist - #882
Merged
Merged
Conversation
The glossary's term table becomes vocabulary.md, framed as which word to use and which to avoid, so agents pick the domain name when they create types, models and resource keys. AGENTS.md now routes to the five knowledge files it did not list (repository-map, admin-areas, plugin-types, module-types, template-types). Two paths that no longer exist are corrected: ICookiePreference lives under Interfaces/Cms, and admin controllers live in Grand.Web.Admin/Controllers.
A shared PreToolUse hook stops Claude Code from committing or pushing while the checkout is on a protected branch, and from pushing to one explicitly. Work reaches those branches only through a pull request.
The checklist is reorganised around the question it exists to answer - what an installation that already holds data goes through on upgrade - and now carries the traps that kept costing time: the migration version gate, the UTF-16 DefaultLanguage.xml that grep cannot read, store-scoped settings replacing the whole object, and PascalCase field names when checking documents by hand. References are updated.
AGENTS.md routing is now one table per kind of file (prompts, workflows, skills, knowledge, glossary, standards, checklists, examples, agents), with knowledge separated from skills and the protected-branch hook named in the operating rules. The vocabulary page is grouped by domain area, the glossary index is rewritten as a lookup table, and the persisted data checklist gets a name that says what it guards.
KrzysztofPajak
changed the title
Read the branch from the hook's cwd, then from any cd <dir> or git -C <dir> in the command, instead of the project root, so a worktree on a feature branch is judged by its own branch. Accept global git options before the subcommand, match refs/heads/ and several refspecs in a push target, and judge each shell segment on its own so text inside another command no longer trips it.
GitHub branch protection already guards develop and main, so the agent-only hook is removed with its settings file; the operating rule stays in AGENTS.md. The tag helper doc comment rewrite is out of scope for this docs change and is reverted.
KrzysztofPajak
changed the title
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.
Type: docs
Issue
Agents working from
AGENTS.mdand.ai/were missing part of the context they need:repository-map,admin-areas,plugin-types,module-types,template-types) existed but were not routed fromAGENTS.md, so agents never loaded them;ICookiePreference.cs, admin controllers folder);Solution
AGENTS.mdrestructured: one table per kind of file (prompts, workflows, skills, knowledge, glossary, standards, checklists, examples, agents), knowledge separated from skills, the five missing knowledge files routed, operating rules tightened..ai/glossary/vocabulary.md: the domain vocabulary grouped by area (catalog, sales, customers, platform, extensibility), with the word to write, the word to avoid and the implementing type. Glossary index rewritten as a lookup table..ai/checklists/persisted-data.md: reorganised around what an installation with existing data goes through, now covering the migration version gate (MigrationManageronly runs migrations newer than the installed version), the UTF-16DefaultLanguage.xmlthat grep cannot read, whole-object store settings and PascalCase field names. All references updated.Interfaces/Cms/ICookiePreference.cs,Grand.Web.Admin/Controllers/(+ Store/Vendor equivalents).Breaking changes
None. Documentation only.
Testing
.ai/*.mdpath referenced from.ai/,.github/andAGENTS.mdexists..mdfile under.ai/(except READMEs) is routed fromAGENTS.md.data-change.mdandrenamed-terms.md.