Name: breakscale-docs
Author: xevrion

Imported from xevrion/breakscale-docs (AGENTS.md). Install upstream with npx skills add xevrion/breakscale-docs. Copyright stays with the author.

Documentation project instructions

Docs for Breakscale, a system design simulator. Built on Mintlify: MDX pages with YAML frontmatter, configuration in docs.json.

Everything under examples/ is generated. Do not edit it.

The 23 example pages are written by tools/example-pages.ts in the simulator's repository, from the presets themselves, and the numbers in them are measured by running each design through the real engine at build time.

Editing a page here is worse than useless: the change is lost on the next generate, and until then the docs disagree with the tool. Fix the preset or the generator instead, then run:

cd ../breakscale   # wherever the simulator repo lives
bun run tools/build-docs.ts ../breakscale-docs

That also rewrites the Examples group in docs.json, so a new preset appears in the navigation without anybody remembering to add it.

The rule the whole project runs on

The numbers have to be true. This is a tool people learn from, so a plausible looking number is worse than no number at all. That applies to prose here as much as to the simulator: do not write "roughly 100 requests a second" beside a table that measured 91.

If a claim cannot be measured or cited, either measure it or cut it.

Style

Second person, active voice
One idea per sentence, and vary the length so it reads like a person wrote it
Sentence case for headings
No em dashes, no arrow chains
Code formatting for file names, commands and paths
Spell out what a number means on first mention: "91 requests a second" rather than "91 rps"

What belongs here

Teaching material: what a design does, why it breaks, what to change. The simulator's own README covers building and contributing to the codebase, and duplicating it here only creates a second copy to drift.

Mintlify tooling

MCP server for editing content and settings: https://mcp.mintlify.com
MCP server for Mintlify's own docs: https://www.mintlify.com/docs/mcp

Install breakscale-docs and it becomes one more candidate the router can pick - when it fits.

A listing is a routing target with a manifest: what it does, which domains it covers, what it costs and who publishes it. Once installed it sits beside your own models and tools, is scored like any other candidate for each request, and shows up in the trace when it wins. Ratings come from workspaces that installed it, one per account.

{ "ocm": "1", "id": "xevrion-breakscale-docs-breakscale-docs", "kind": "skill", "name": "breakscale-docs", "description": "Docs for [Breakscale](https://github.com/xevrion/breakscale), a system design simulator. Built on Mintlify: MDX pages with YAML frontmatter, configuration in `docs.json`.", "publisher": "xevrion", "version": "1.0.0", "capabilities": { "domains": [ "general" ], "tags": [ "skill-md", "github-agents" ], "languages": [ "en" ] }, "quality_prior": 0.6, "examples": [ "Docs for [Breakscale](https://github.com/xevrion/breakscale), a system design simulator. Built on Mintlify: MDX pages with YAML frontmatter, configuration in `docs.json`." ], "primary": false, "metadata": { "source": { "provider": "github-agents", "repository": "https://github.com/xevrion/breakscale-docs", "path": "AGENTS.md", "ref": "794996a9449b8e987e7e597baffa562f2d5dafac", "url": "https://github.com/xevrion/breakscale-docs/blob/794996a9449b8e987e7e597baffa562f2d5dafac/AGENTS.md", "key": "xevrion/breakscale-docs/AGENTS.md" } }, "instructions": "# Documentation project instructions\n\nDocs for [Breakscale](https://github.com/xevrion/breakscale), a system design\nsimulator. Built on Mintlify: MDX pages with YAML frontmatter, configuration in\n`docs.json`.\n\n## Everything under examples/ is generated. Do not edit it.\n\nThe 23 example pages are written by `tools/example-pages.ts` in the simulator's\nrepository, from the presets themselves, and the numbers in them are measured by\nrunning each design through the real engine at build time.\n\nEditing a page here is worse than useless: the change is lost on the next\ngenerate, and until then the docs ", "cost": { "context_tokens": 506 } }

breakscale-docs

About

Documentation project instructions

Everything under examples/ is generated. Do not edit it.

The rule the whole project runs on

Style

What belongs here

Mintlify tooling

Install breakscale-docs and it becomes one more candidate the router can pick - when it fits.

Use it

Manifest

Reviews