Repository navigation
docs: make the setup prompt, FAQ, plugin README and bench text match what onsystem does - #241
Merged
Merged
Conversation
…what onsystem does /setup.md told Claude Code never to add onsystem to .mcp.json, while docs/clients.md offers one committed .mcp.json for the team and turns it off for Claude Code with "disabledMcpjsonServers". The setup prompt now says the same, and gives Codex CLI the hook it installs (trusted in /hooks). The FAQ and the llms.txt summary said the hook is Claude Code only; it runs in Codex CLI too. - plugins/onsystem-agent/README.md: Copilot CLI installs from the marketplace, not by the deprecated direct install; VS Code loads the folder through chat.pluginLocations. - Antigravity joins the client lists in docs/quickstart.md and the /docs/clients description. - docs/tools.md links to the "How the server finds your project" anchor. - bench/v2: LABELLING.md names the three automatic scorers, the README says prepare checks tsc and onsystem only, and that the hook was Claude Code only when the benchmark ran (0.5.0; Codex since 0.8.0). - scripts/corpus-lib.ts: the audit labels' comment says what the report does with them. - llms-full.txt: a code block with a line that starts with # (the get_component answer, a shell comment) is indented two spaces, so the file's own outline has only its sections. CommonMark parses the same code blocks. New checks in test/docs-agree.test.ts and site/test/docs-agree.test.ts. os-text-followups
…st content not sentences - FAQ: say only that Claude Code and Codex CLI run the hook. - Agent Plugins README: keep the deprecation, drop "as this folder would need". - LABELLING.md: the labeller says what each scorer missed, and which of onsystem's findings are wrong. - Home page: Antigravity in the Works with list, with a test that the list names every client in docs/clients.md. - docs-agree tests assert what the pages say, not their exact sentences. - The /docs/clients description notes its 160-character cap and what to shorten first.
dgesteves
added a commit
that referenced
this pull request
Oct 28, 2026
#201 shipped in 0.9.1, #202 in 0.10.0 and #199 in 0.10.1, as the changelog shows; #200, #203 and #204 are website and docs changes, live since they merged. Main is at 0.10.1 with no pending changesets, so nothing is merged and waiting for a release. In review now lists the open pull requests #241 and #242.
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.
Roadmap item: os-text-followups (review follow-ups from OS2-28 #185, OS2-44 #192 and the bench wording). Docs and copy only, so no changeset.
Each point was checked against current main, after #199, #203 and #204 merged. Point 6 was already fixed on main, so it is dropped (see below). The rest still reproduced.
What was wrong
/setup.md (
site/lib/llms.ts:98) told Claude Code "Do not add onsystem to.mcp.jsonas well". Since docs(clients): lead with the setup; add Antigravity, Gemini folder trust, Copilot via the marketplace and one .mcp.json #185,docs/clients.mdoffers one committed.mcp.jsonfor the team, and Claude Code keeps the plugin and adds"disabledMcpjsonServers": ["onsystem"]to.claude/settings.json(docs/rollout.mdsays the same). The Codex CLI step listed only "the MCP server and the skill". The plugin Codex installs also runs the hook onapply_patch(plugins/onsystem/hooks/check-ui.mjs:283, since 0.8.0, fix(hook): check the files a Codex apply_patch changes; init offers an AGENTS.md section #182), once the hook is trusted in/hooks.plugins/onsystem-agent/README.md:25gavecopilot plugin install dgesteves/onsystem:plugins/onsystem-agent, the direct install that Copilot CLI has deprecated.docs/clients.mdgives the marketplace route.FAQ (
site/lib/faq.ts:45): "The hook ... ships for Claude Code only so far." Thellms.txtsummary (site/lib/llms.ts:34) said the same ("In Claude Code, a hook ...").docs/clients.mdsays Claude Code and Codex CLI both run it.Antigravity has a setup block in
docs/clients.md, butdocs/quickstart.md:42and the/docs/clientsdescription insite/lib/docs.tsleft it out.docs/tools.mdlinked toclients.mdwith no anchor. docs(clients): lead with the setup; add Antigravity, Gemini folder trust, Copilot via the marketplace and one .mcp.json #185 added## How the server finds your projectthere.bench/v2:
LABELLING.md:3said "two automatic scorers". Scoring lists four measures, and three of them are automatic:tsc, onsystem and @shadcn/lint.README.md:93said "preparechecks that the scorers can be trusted".runControlsinlib/repo.mjscheckstscand onsystem only.README.md:20said "onsystem ships its hook only for Claude Code" in the present tense.scripts/corpus-lib.ts:283said "so not an estimate" on the audit tally. The report prints only that tally's counts, never a rate.llms-full.txt: these lines start with
#inside code blocks:docs/tools.md'sget_componentexample:# Badge,## Propsand## Variantsdocs/ci.md's shell block:# Baseline: 1,340 findings ...A reader who splits the file at its
#lines got a second top-level title and two extra##sections. The Tools section ended at## Props.What changed
site/lib/llms.ts:.mcp.jsonentry for Claude Code. When the repository already commits one with onsystem for the other clients, it says to add"disabledMcpjsonServers": ["onsystem"]to the same.claude/settings.json, asdocs/clients.mddoes./hooks.llmsFullTxt, a code block that has a line starting with#is indented two spaces. All other code blocks are unchanged.site/lib/faq.ts: the hook runs in Claude Code and Codex CLI (trusted in/hooks). It says nothing about other agents: per review, Copilot CLI's changelog says it runs Claude-format plugin hooks, andcheck-ui.mjs(lines 272-279) already reads Copilot's and VS Code's edit-tool fields, but the hook has not been run in either (follow-up below).site/lib/docs.ts: Antigravity is in the/docs/clientsdescription. A comment next to it says it must name every client and stay at 160 characters (151 now), and what to shorten before adding the next one.site/app/page.tsx(the Works with list only): Antigravity after Gemini CLI.docs/quickstart.md: Antigravity is in the client list. The list now matches the README's.docs/tools.md: the link goes toclients.md#how-the-server-finds-your-project.plugins/onsystem-agent/README.md:npx -y onsystem@0.10.1, and the two SKILL.md files are byte-identical.chat.pluginLocations, asdocs/clients.mdsays. The intro says "for VS Code and any other client of the standard".bench/v2/LABELLING.md: names the three automatic scorers and links Scoring. The labeller says what each scorer missed, and which of onsystem's findings are wrong:labels.csvcounts the violations in each file, andfindings.csvhas a verdict for each onsystem finding only (labelSummaryinlib/stats.tscompares the labels with onsystem alone).bench/v2/README.md:preparecheckstscand onsystem. @shadcn/lint, added after the standard run, is not part of that check.apply_patchsince 0.8.0 (fix(hook): check the files a Codex apply_patch changes; init offers an AGENTS.md section #182).scripts/corpus-lib.ts(comment only): the audit labels were picked because they looked suspicious, so their share of false positives says nothing about the rate, and the report prints only their counts.Different from the brief
docs/required-check.md:49: "The action runs the onsystem your project installed ... Without an install, each release of the action runs the CLI of the same version (npx onsystem@<version>)." The step comment inaction.yml:42-45says the same. Both came from d81ac48, in fix(baseline): follow moved files, accept findings off the changed lines first, and run the installed CLI in the Action #192's own fix round. I checked them againstaction/check.mjs: lines 235-295 find the install and fall back to npx at the action's version, and lines 362-365 print the version notice. Nothing to change.# Badgeto#### Badgewould changeget_component's real answer. The fix indents the whole block (fences included) by two spaces. CommonMark strips that indent again (a fence indented N spaces removes up to N from each content line). I checked with markdown-it 14.1.0, installed with--ignore-scriptsin a scratch folder. It parses main's and this branch'sllms-full.txtto the same 96 code blocks with identical content and the same 119 headings. The shell comment indocs/ci.mdis covered by the same rule./docs/clientsdescription dropped "without the plugin". Adding "Antigravity, " made it 170 characters.site/test/shell.test.tscaps docs descriptions at 160. It now ends "... Antigravity, Grok Build and Claude Code." (151).llms.txtsummarybench/v2/README.md:20How it was tested
Two new test files. Every test in them fails on main and passes here (checked by putting main's versions of the other changed files back and running both files: 6 of 6 and 6 of 6 failed). They check what the pages say, not their exact sentences: terms in the same paragraph of
docs/clients.md, the Scoring titles that name each scorer, and the clause that says whatpreparechecks.test/docs-agree.test.ts, 6 tests, all 6 fail on main:docs/clients.mddocs/clients.mdgives, with no direct installdocs/tools.mdlinks to the anchor, and the heading existsprepareparagraph namestscand onsystem as what it checks, andrunControlsinlib/repo.mjsscores its controls withtypecheckandonsystemCheckonlysite/test/docs-agree.test.ts, 6 tests, all 6 fail on main:disabledMcpjsonServersline fromdocs/clients.md/hooks/docs/clientsdescription names every client with a setup block#,# onsystemis the only#line, and the Tools section, cut at##lines, runs to thecheck_uiexampleGate, all passing on 0ac646c (main is still 42bf9d6):
pnpm install --frozen-lockfile --prefer-offlinepnpm format:checkpnpm lintpnpm typecheckpnpm buildschema.jsonunchangedpnpm testpnpm --filter site generatepnpm --filter site testpnpm --filter site typecheckpnpm --filter site lintpnpm --filter site buildpnpm corpuscorpus/pnpm smokewas not run: no MCP server or tool code changed.I checked the pages this changes in the built output (
.next/server/app):setup.md,llms.txt,llms-full.txt,/,/docs,/docs/clients,/docs/faqand/docs/tools. The home page lists Antigravity between Gemini CLI and Grok Build. I also diffed the generatedllms.txt,llms-full.txtandsetup.mdagainst main's. The only changes are the lines above and the two indented blocks.Follow-ups (outside this PR's files)
plugins/onsystem/hooks/check-ui.mjsreads Copilot's and VS Code's edit-tool fields, but no one has run it there.docs/clients.md's support tiers are unchanged here..mcp.jsonand.vscode/mcp.json. That needs a run in VS Code (docs/clients.md,docs/rollout.md). /setup.md's VS Code step is unchanged here until that is settled.