vrr/CodeNomad
2
0
Fork 0
mirror of https://github.com/NeuralNomadsAI/CodeNomad.git synced 2026-10-23 14:51:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
CodeNomad/dev-docs/INDEX.md
Pascal André 7a1fc90310
docs(agents): keep AGENTS.md to universal rules and agent docs to the current state (#1082) 
AGENTS.md loaded about 33,000 tokens into every agent session, subagent and reviewer, mostly per-feature contracts, and the agent documentation around it had accumulated duplicates, dated logs and history of removed designs. This PR makes AGENTS.md a short set of rules that apply everywhere plus an index of area documents, and leaves AGENTS.md, dev-docs and the repository skills describing only the current state.

Three commits, reviewable separately:

1. **Move (lossless).** Every per-area rule moved verbatim from AGENTS.md into its area document (existing ones, or six new ones: UI_CONVENTIONS, UI_SHELL, COMPOSER, TRANSCRIPT, SETTINGS, PROJECTS). A script split the old file into 208 units, required one destination for each and checked all 199 content units verbatim at their destination. AGENTS.md went from 134,000 to 16,000 characters.
2. **Trim.** A per-area ponytail review removed rules stated two or three times (keeping the more precise copy), dated validation logs, per-version qualification sections below the current minimum, abandoned designs and self-references; seven documents whose surviving rules live elsewhere were deleted. It also fixed statements the code contradicts (locale registration, the Mission play/recovery condition, plugin package updates, cleanup progress UI, timeline index persistence, automation restart/targets, stale pins and minimums).
3. **Current state only.** The new AGENTS.md rule: no history (removed features and their names, former behavior, provenance, dated logs) and no denials; correct a contradicted statement at its source. DEVELOPER_MODE.md is merged into BROWSER_AUTOMATION.md and every Developer Mode mention is gone (including the README and the browser help page in ten locales). Names that only made sense against older designs are renamed with every reference updated, MISSIONS_ENVIRONMENT_ADMISSION is folded into SESSION_ENVIRONMENT, and INDEX lists every document. The server npm README now states the real OpenCode minimum (2.1.2).

AGENTS.md is now about 14,000 characters (roughly 3,500 tokens); AGENTS.md, dev-docs and the vendor README went from about 11,200 lines to under 4,700.

Validation: every relative Markdown link and every cited dev-docs path resolves; no reference to a renamed or deleted document remains; `npm run test:help` passes for all ten locales.

Review: three independent GPT-6.1 Sol (high) reviews by area found binding rules lost in the trim and current-state passes; 25 were restored as present-tense facts or prohibitions and four contradicting statements corrected, each checked against code. A Fable 5.1 gatekeeper review of the whole PR passed; its follow-up routes session recovery from the index, points to dev-docs/INDEX.md and documents the family identity read.
2026-10-21 16:59:43 +02:00

4.5 KiB
Raw Permalink Blame History

Documentation Index

Start with README for installation and usage, then architecture for ownership boundaries and code locations. AGENTS.md defines the rules that apply everywhere (styling, i18n, contribution) and indexes the area documents whose rules bind each area.

Runtime and ownership

History and pruning

UI and extensions

  • UI conventions: dialogs, utility windows, icon toggles, surfaces and scrollbars.
  • Application shell: panel toggles, drawers, tabs, session sidebar and native menus.
  • Composer: context selectors, height, focus, delivery, attachments and mentions.
  • Transcript rendering: Message content presets, token lines, tool renderers and lifecycle signals.
  • Settings and Preferences: settings rows, the Preferences window, Providers/Web search, Stats and notifications.
  • Projects and tabs: closing tabs, temporary workspaces, the new-instance launcher and Git-unavailable mode.
  • Public user help: multilingual static site, stable anchors, local search, app entry points and Pages validation.
  • Files panel: workspace editing, Git changes/history and preview lifecycle.
  • Questions and permissions: permissions/Forms dock, drafts and pending-request recovery.
  • Keyboard shortcuts: the shortcut catalog, recording and dispatch.
  • Provider accounts: native account selection, usage credentials and bounded quota/rotation policy.
  • Plugin controls: explicit Global/Project activation and native package check/update.
  • Panel extensions: distribution, trust, consent and sandbox/API boundaries.
  • Palette sources: color provenance and validation.

Missions

  • Missions: one-time Mission maps, native admission, Wayfinder/Debugging/Product delivery playbooks and validation.
  • Recurring Missions: daily native schedule contract; the qualification fixture runs its journeys against an isolated runtime.
  • Autonomy requirement: Missions run in the OpenCode service with the CodeNomad UI and backend closed.

Desktop automation and validation