Add engineering context map and public context index - #5928
Merged
Merged
Conversation
Add AGENTS.md as the entry point for finding and preserving design rationale, docs/README.md as the index of public sources, and docs/decisions/README.md with ADR guidance. CLAUDE.md imports AGENTS.md for Claude Code versions before 2.1.281.
danielmarbach
requested review from
andreasohlund,
johnsimons,
rbev and
warwickschroeder
September 25, 2026 10:30
ramonsmits
reviewed
Sep 25, 2026
Testing pages are already indexed by docs/testing.md. In a comparison of index variants, the shorter index with one-clause descriptions reached the right source in fewer tool calls than the full listing and than a names-only list.
AGENTS.md changes only when the workflow changes; decisions go in the sources it points to. The index lists sources that explain why, one clause each, and defers how-to material to existing indexes.
andreasohlund
approved these changes
Sep 25, 2026
Contributor
Author
|
I'm thinking on how we can make the agent file better repo shippable too but that is something we can worry about later in my opinion |
Contributor
Author
|
Discussed it with Andreas and we concluded having it in master allows the other PRs to be rebased and benefit from it. We can always make more tweaks. Merging |
This was referenced Sep 25, 2026
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.
This adds a small map for people and coding agents working in this repository:
AGENTS.md: where to look when investigating existing behavior, how to recover a pull request fromgit log, and when a change deserves an ADR rather than only a pull request description.docs/README.md: an index of the design and testing docs we already have underdocs/, plus a short list of pull requests that are the canonical record for a decision. There's a rule at the top of that list for what qualifies, so it doesn't turn into "recent PRs".docs/decisions/README.md: ADR guidance for the cases where a pull request isn't a good long-term entry point.Nothing moves, no CI changes, and nothing here adds a requirement for contributors. Pull request descriptions stay the place where single-component decisions get recorded; the map just makes them findable.
I tuned the
AGENTS.mdwording by running a few agents against real questions about this repo (why ingestion batches are parallel for some persisters, why new RavenDB databases use Lucene, whether the paging change deserved an ADR) and adjusted until they consistently landed on the right source and stopped proposing ADRs for things a pull request already records. The steps about a private context root are there so an agent knows what to do when a person explicitly provides extra context; without that, they are inert.What I'd appreciate a look at: whether the docs listed in
docs/README.mdare the ones you'd actually send someone to, and whether the pull request list has the right entries. Feel free to push changes directly; I'm not attached to the wording.Update: I trimmed
docs/README.mdto the sources that explain why, after comparing four index variants (no index, full with descriptions, trimmed with descriptions, names only) on five questions, two runs each. The trimmed version with one-clause descriptions reached the right source in the fewest tool calls (2.6 on average versus 3.3 for the full list) and was the only variant with descriptions that never missed. Testing pages stay reachable throughdocs/testing.md.AGENTS.mdalso gained two sentences: it changes only when the workflow changes, and how the index is built.