Refactor docs: conventional README.md + LLM-optimized AGENTS.md - #61
Merged
Conversation
Chuccle
force-pushed
the
claude/readme-agent-docs-refactor-50hvyg
branch
from
September 1, 2026 02:17
1198a1d to
b3dc7f6
Compare
Replaces the sprawling root README.md (project overview mixed with an
~1400-line performance investigation log) plus deploy/README.md and
deploy/DEBUGGING.md with two files:
- README.md: a conventional, concise, human-facing overview — what the
project is, layout, build/test/deploy commands, and a pointer to
AGENTS.md.
- AGENTS.md: the single home for all agent documentation and context
(for any tool, not a per-tool file), organized for LLM consumption
rather than straight-through reading:
- A table of contents and a Quick reference section up front —
commands, always-true rules, top footguns, current read-ahead
settings — each linking to its full section.
- Sections ordered rules-first, reference-second: operating rules
(what's expected, the full-pass checklist, documentation
discipline, conventions) come early since they apply to every
task; build/CI/sanitizers/deploy/debugging/perf reference material
follows; the two large evidence/design sections are last since
they're read occasionally, not every session.
- deploy/DEBUGGING.md folded in as its own section rather than a
separate file, with content it duplicated against deploy/README.md
(the NMI bugcheck notes, the KdBreakPoint() writeup) consolidated
into one place.
- The playback-stutter investigation compressed into its
conclusions, ruled-out hypotheses, the three built-and-reverted
experiments, and the reusable measurement-methodology lessons —
full round-by-round measurement history stays recoverable from
earlier commits, not reproduced in the file every session loads.
- The on-disk cache design retitled "Future work: on-disk hot cache
(not implemented)" with a banner marking it an unstarted project.
- Conventions extended with kernel-stack conservatism (flat call
tree, bounded recursion, prefer pool over large stack frames),
false-sharing avoidance (pad/align contended per-processor state
to a cache line), and avoiding atomics except where correctness
requires them — each grounded in existing precedent in this
codebase (Statistics.h's padded per-processor counters and its
removal of a shared interlocked gauge; the Fcb/Dcb/Vcb refcounts
and OnReapList/ThreadsActive claim flags that keep Interlocked
ops because correctness genuinely needs them).
No source, build, or CI files touched.
Chuccle
force-pushed
the
claude/readme-agent-docs-refactor-50hvyg
branch
from
September 1, 2026 02:23
3b59a9a to
a5dbf93
Compare
Chuccle
marked this pull request as ready for review
September 1, 2026 02:24
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
Replaces the sprawling root
README.md(which mixed a project overviewwith an ~1400-line performance investigation log) plus
deploy/README.mdand
deploy/DEBUGGING.mdwith a two-file structure:README.md— a conventional, concise, human-facing overview: whatthe project is, layout, build/test/deploy commands, and a pointer to
AGENTS.md.AGENTS.md— the single home for all agent documentation andcontext (for any tool, not just one), reorganized for LLM consumption
rather than straight-through reading:
commands, always-true rules, top footguns, and current read-ahead
settings, each linking to its full section.
(what's expected, the full-pass checklist, documentation discipline,
conventions — including a new rule on keeping the kernel call tree
flat and being conservative with kernel stack usage) come early since
they apply to every task; build/CI/sanitizers/deploy/debugging/perf
reference material follows; the two large evidence/design sections are
last since they're read occasionally, not every session.
deploy/DEBUGGING.mdfolded in as its own section rather than aseparate file; overlapping content between it and
deploy/README.md(e.g. the NMI bugcheck notes, the
KdBreakPoint()writeup) consolidatedinto one place instead of two.
conclusions, ruled-out hypotheses, the three built-and-reverted
experiments, and the reusable measurement-methodology lessons — the
full round-by-round measurement history remains recoverable from this
branch's git history, not reproduced verbatim in the file everyone
loads every session.
(not implemented)" with a banner making explicit it's an unstarted
project with no code in the tree yet.
CLAUDE.mdremoved — there is no per-tool file; Claude Code-specificnotes (e.g. the optional
Stophook backstop) are folded intoAGENTS.md.Docs-only change; no source, build, or CI files touched.
Test plan
section-reorder-broken "see X above/below" pointers within
AGENTS.md) resolves correctly.the removed
deploy/README.md,deploy/DEBUGGING.md, orCLAUDE.md, other than one comment intools/Measure-BlorgScaling.ps1which was repointed atAGENTS.md.Generated by Claude Code