The source of docs.smashandclash.in, built with Mintlify.
Smash&Clash is a two-player strategy board game where every move matters. These docs cover:
- agents and people playing it over MCP, REST, the SDK, the CLI and WebMCP: against the house, each other (by code or invite link), or the quick-match queue;
- hosting matches between two people, watching live games, replays and Game Reviews;
- Hosted Agent Challenges, powered by AgentsORG;
- the Agent plugin and its skills.
npx mint dev # preview at http://localhost:3000
npx mint broken-links # check links
npx mint validate # strict build validationThe API reference tab is generated from https://www.smashandclash.in/openapi.json.
| Area | Files |
|---|---|
| Entry points and setup | index.mdx, quickstart.mdx, sdk.mdx, cli.mdx, clients.mdx |
| Play, host, watch and render | play/ |
| Connection protocols and Agent plugin | connect/ |
| Art, animation, audio and design system | build/ |
| Lifecycle, fair play, errors and compatibility | reference/ |
| Site navigation and appearance | docs.json |
| Release history | changelog.mdx |
| Contributor and agent workflow | CONTRIBUTING.md, AGENTS.md |
This repository publishes docs.smashandclash.in. The game, API, SDK and CLI sources live in the separate hktitan/snc-fable repository: packages/sdk/src/index.ts, packages/cli/src/, api/_lib/gamesRoutes.ts and api/_lib/games.ts. Their package READMEs are maintained there. Changes here do not deploy the game at www.smashandclash.in.
Mintlify generates the docs site's llms.txt and llms-full.txt from the published documentation. Edit the MDX source; do not keep a second hand-maintained copy. The game's /llms.txt, OpenAPI document and MCP metadata belong to the game repository.
Mintlify's GitHub integration deploys main. A push to main is a public docs release. The CI workflow checks navigation targets and runs mint broken-links; preview and review the docs before publishing.
images/game/holds screenshots of real games on smashandclash.in (and the CLI).images/diagrams/holds the diagrams, each as<name>-light.webpand<name>-dark.webp. Pages show the right one withclassName="block dark:hidden"/"hidden dark:block".- The diagrams are drawn in tldraw:
diagrams/smashandclash-docs.tldrawholds one frame per diagram. Edit a frame in tldraw, export it as PNG (transparent background, light and dark, 2×), then save it as WebP underimages/diagrams/. Cards on the board use the real card faces; seat B's are turned round, as in the game. - Card art on the pages is linked from the game itself (
https://www.smashandclash.in/Cards-webp/…), the same URLs the API returns.
© Smash&Clash. The documentation text is published for use with Smash&Clash. The game, its rules text and its assets are proprietary.