Xinmin Zeng 2a97ec3e58
docs: turn README into an index and move reference detail to docs/guide (#8113)
* docs: turn README into an index and move reference detail to docs/guide

The README had grown to 393 KB because every change appended its notes there. The text moves verbatim into 18 topic guides under docs/guide/; only headings are re-leveled and relative links re-pointed. The README keeps the introduction, a quick start and a guide index. Contributor test notes move to CONTRIBUTING.md.

* docs: send user docs to topic guides and budget the root README

The rule 'update README.md for user-facing changes' is what grew the README. Guidance now points to docs/guide/, and check_agent_guidance.py fails when the root README exceeds 16 KiB (AG003).

* chore: remove unreferenced screenshots and finished plan notes

pr-build/ holds two PR screenshots (3 MB) from #1986. plans/ holds the plan for the merged #4049. docs/SKILL_NAME_CONFLICT_FIX.md is a February change note. Nothing references them.

* docs: route always-loaded AGENTS.md files to scoped guides

* docs(agents): cut scoped guides to scope, verify, traps, decisions

Each AGENTS.md keeps four kinds of content: the scope of the directory, the
verification commands, traps a local test run does not show, and decisions the
code cannot state. Values, field lists, function inventories, test names, issue
numbers and history are deleted, because the code, the tests and git state them.

Search and fetch providers share one community guide. Four guides with no
remaining content are removed. The size check now allows 6 KiB per file (hard
limit 8 KiB) and 24 KiB per chain (hard limit 32 KiB).

* style: format frontend guide table and guidance test imports

---------

Co-authored-by: Willem Jiang <willem.jiang@gmail.com>
2026-11-11 13:26:17 +08:00

1.5 KiB

Model catalog (core/models/)

cd frontend && pnpm rstest run core/models
  • The catalog shows authorized models only. Recent choices are stored per user and browser.
  • reasoning.ts is the only reader of the reasoning contract. It also handles the fallback to the deprecated capability booleans for an older Gateway. Components do not read those booleans directly.
  • Effort values are open strings, so a provider-specific value passes through local settings and account preferences unchanged. The custom agent dialog offers only the values that the per-agent schema also allows.
  • A required-thinking model never resolves to the mode without thinking.
  • management.ts allows a fixed set of editable fields, so source metadata and has_api_key are never posted. Entries from YAML are read-only.
  • A draft credential lives in editor state only, never in the query cache or browser storage. A blank field keeps the saved key, and an explicit removal sends an empty key. A change of provider or endpoint clears test results and the reuse of the saved key.
  • Provider form metadata comes from the backend. Do not copy endpoints, protocols or adapter maps into the UI.
  • A successful save or toggle invalidates the admin catalog and MODELS_QUERY_KEY, so open chat and agent selectors refresh.
  • Static demos and non-admin users never query the management API. Closing the editor aborts running probes and ignores their late callbacks.