Skip to content

docs: rewrite AGENTS.md for the four-model, model-library era - #10

Merged
NeelM0906 merged 1 commit into
mainfrom
claude/agents-md-refresh
Aug 4, 2026
Merged

docs: rewrite AGENTS.md for the four-model, model-library era#10
NeelM0906 merged 1 commit into
mainfrom
claude/agents-md-refresh

Conversation

@NeelM0906

Copy link
Copy Markdown
Owner

What changed

AGENTS.md still described a Gemma-only checkout whose purpose was "running and reporting existing behavior". Rewritten to match the current repo:

  • Header/scope: four pinned MoE families; scope is now "make only the changes the user asks for, surgically" rather than read-only, since the repo is under active feature development. The model-run safety rules are explicitly always-on.
  • Layout/commands: adds Sources/ChatTemplate/ (Core/UI/Mac); example commands use the --model installer flag and note the ~15 GB → ~148 GB download range with pointers to the DSV4/Inkling pre-install docs.
  • New "Models and the library" section: canonical install-directory names, manifest-based (not name-based) detection, the app's library-root scan order and toolbar picker, defaults write Mference model … / MFERENCE_MODEL selection, and the --verify integrity modes (strict full-sha256 default, trusted-receipt opt-in, from fix: Inkling FP16 expert-row clip that rendered as "!!!!"; speed up prefill #7).
  • Test rules: model requirement generalized from scratch/gemma4.gturbo to "the model the run needs"; notes env-gated real-model suites (e.g. MFERENCE_INKLING_GTURBO); adds the benchmarks baseline pointer.
  • App controls: describes the current shell — recency-grouped sidebar, toolbar model picker with download rows, streaming markdown transcript, glass composer with attachments, and realtime tok/s / tokens / memory in the inspector.
  • Unchanged: local-server binding rules, the process-check list, one-model-process-at-a-time, benchmark protocol discipline, and the reporting requirements.

Note on ordering

The Sources/ChatTemplate/ layout line, the library/picker description, and the app-controls section describe #6 — merge #6 before (or with) this PR so AGENTS.md doesn't get ahead of the tree.

Verification

ruby Scripts/check_markdown_links.rb — 26 files, all local links and anchors resolve.

🤖 Generated with Claude Code

The file still described a Gemma-only, run-and-report checkout. Now it
covers: all four pinned families with per-family install docs and disk
ranges; the ChatTemplate targets in the layout; the model library
(root scanning, manifest-based detection, toolbar picker) versus
explicit --model paths for CLI/server; the --verify integrity modes
with strict full-sha256 as default; env-gated real-model test suites;
the benchmark baselines pointer; and the current app shell (sidebar,
model picker, streaming markdown transcript, glass composer, realtime
inspector metrics). The model-run safety rules, server binding rules,
and reporting requirements are carried over unchanged.
@NeelM0906
NeelM0906 merged commit 99c9563 into main Aug 4, 2026
4 checks passed

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 7367da3fa5

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread AGENTS.md
Comment on lines +47 to +48
roots — the `Mference.libraryRoot` default if set, the package checkout's
`scratch/`, and `~/Library/Application Support/Mference` — and auto-adopts

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Use the actual model-directory preference key

The app never reads a Mference.libraryRoot default (rg -n 'libraryRoot' only finds this new AGENTS entry); AppModelLocation.storageKey is Mference.modelDirectory, and AppModelLocation.resolve(...) chooses one explicit model directory/package scratch/Application Support path rather than scanning a library root. Agents following this instruction will set or debug a preference the app ignores, which makes model-location automation unreliable.

Useful? React with 👍 / 👎.

Comment thread AGENTS.md
Comment on lines +49 to +50
installed models; its toolbar picker switches between families and offers
downloads for missing ones. The CLI and server take an explicit `--model`

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Remove the nonexistent toolbar model picker

The current Mac UI does not have a toolbar picker that switches families or lists downloads for missing models: the header renders a static ModelStatusBadge, and model selection is via AppModelInstallDescriptor.selected at launch or the “Choose Existing Model…” path. Documenting this as existing behavior will misdirect agents working on model-selection or install flows, and the same wording should be corrected wherever it appears in this file.

Useful? React with 👍 / 👎.

@NeelM0906

Copy link
Copy Markdown
Owner Author

Re the two Codex P2 comments (Mference.libraryRoot not read anywhere; no toolbar model picker): both are accurate against main at review time, and both describe features that live in #6ModelLibrary (which defines and reads Mference.libraryRoot, scans library roots, and detects installs by manifest) and ModelStatusMenu (the toolbar picker with per-family download rows). This PR's description flagged that ordering dependency ("merge #6 before or with this PR"); #10 landed first, so AGENTS.md is briefly ahead of the tree. #6 is mergeable and clean — once it lands, both comments are resolved with no doc change needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant