Skip to content

Commit 8df4352

Browse files
kronosapiensclaude
andauthored
feat: make docs AI-native with llms.txt, robots.txt, and aiCta (#217)
feat: make docs AI-native with comprehensive llms.txt, robots.txt, and aiCta - Update llms.txt with all 40+ documentation pages across Controller, Arcade, and Slot products - Add robots.txt for AI crawler discovery following llms.txt standard - Configure aiCta in vocs.config.ts with Cartridge-specific context for ChatGPT integration - Fix stale page references and raw GitHub markdown URL patterns (.md extension) Agents can now discover the documentation, fetch clean markdown sources, and install specialized Cartridge skills for enhanced assistance. Co-authored-by: Claude Haiku 4.5 <noreply@anthropic.com>
1 parent 1eb4430 commit 8df4352

File tree

3 files changed

+72
-30
lines changed

3 files changed

+72
-30
lines changed

src/public/llms.txt

Lines changed: 62 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,76 @@
1-
2-
llms.txt
31
# docs.cartridge.gg
42

53
> Welcome to Cartridge - High Performance Infrastructure for Provable Games and Applications.
64

7-
## /controller
5+
## For AI Agents
6+
7+
Install Cartridge skills for your coding agent:
8+
9+
```
10+
npx skills add cartridge-gg/agents
11+
```
12+
13+
Raw markdown source for any documentation page is available on GitHub:
14+
15+
```
16+
https://raw.githubusercontent.com/cartridge-gg/docs/main/src/pages/{path}.md
17+
```
18+
19+
For example, the Controller overview at `/controller/overview` has its source at:
20+
`https://raw.githubusercontent.com/cartridge-gg/docs/main/src/pages/controller/overview.md`
21+
22+
## Controller
23+
24+
- [Overview](https://docs.cartridge.gg/controller/overview): Gaming-focused smart contract wallet with session keys, identity management, and customization.
25+
- [Getting Started](https://docs.cartridge.gg/controller/getting-started): Install, initialize, and integrate Cartridge Controller into your application.
26+
- [Authentication](https://docs.cartridge.gg/controller/signer-management): Add and manage multiple authentication methods including Passkeys, social login, and external wallets.
27+
- [Sessions](https://docs.cartridge.gg/controller/sessions): Session-based authentication and policy-based transaction approvals.
28+
- [Presets](https://docs.cartridge.gg/controller/presets): Customize your Cartridge Controller with presets.
29+
- [Configuration](https://docs.cartridge.gg/controller/configuration): Chain settings, session management, and theme customization options.
30+
- [Starter Packs](https://docs.cartridge.gg/controller/starter-packs): Pre-configured bundles of game assets and credits with streamlined payment flows.
31+
- [Booster Packs](https://docs.cartridge.gg/controller/booster-packs): Reward system for claiming game credits, tokens, and passes via Merkle Drop.
32+
- [Inventory](https://docs.cartridge.gg/controller/inventory): Inventory modal for managing ERC-20 and ERC-721 assets.
33+
- [Coinbase Onramp](https://docs.cartridge.gg/controller/coinbase-onramp): Fiat-to-crypto purchase integration for gaming applications.
34+
- [Usernames](https://docs.cartridge.gg/controller/usernames): Username and address lookup service with API access and helper methods.
35+
- [Achievements](https://docs.cartridge.gg/controller/achievements): Achievement system for rewarding players and tracking in-game progress.
36+
- [Quests](https://docs.cartridge.gg/controller/quests): Time-based challenges with rewards and progress tracking.
37+
- [Toast Notifications](https://docs.cartridge.gg/controller/toast-notifications): Display contextual notifications for transactions, achievements, and marketplace activities.
38+
- [Architecture](https://docs.cartridge.gg/controller/architecture): Technical overview of the Controller smart contract architecture and security model.
839

9-
- [Overview](https://docs.cartridge.gg/controller/overview): Explore Cartridge Controller, a gaming-focused smart contract wallet that makes Web3 gaming accessible and fun with features like session keys, identity management, and customization options.
10-
- [Getting Started](https://docs.cartridge.gg/controller/getting-started): Get started with Cartridge Controller by learning how to install, initialize, and integrate it into your application with various frameworks.
11-
- [Passkey Setup & Support](https://docs.cartridge.gg/controller/passkey-support): Understand how Cartridge Controller uses Passkeys for secure credential management, including platform support and backup solutions.
12-
- [Configuration](https://docs.cartridge.gg/controller/configuration): Explore the configuration options available for Cartridge Controller, including chain settings, session management, and theme customization.
13-
- [Sessions and Policies](https://docs.cartridge.gg/controller/sessions): Learn about Cartridge Controller's session-based authentication and policy-based transaction approvals system.
14-
- [Paymaster](https://docs.cartridge.gg/controller/paymaster): Learn how to use the Cartridge Paymaster to provide seamless and fee-less user experiences.
15-
- [Presets](https://docs.cartridge.gg/controller/presets): Learn how to customize your Cartridge Controller.
16-
- [Looking up Usernames / Addresses](https://docs.cartridge.gg/controller/usernames): Discover how to use Cartridge Controller's username and address lookup service, including API access, helper methods, and best practices.
17-
- [Achievements](https://docs.cartridge.gg/controller/achievements): Learn about Cartridge's Achievement system that allows games to reward players for completing in-game objectives and track their progress.
18-
- [Inventory](https://docs.cartridge.gg/controller/inventory): Learn how to use and configure the Cartridge Controller's Inventory modal for managing ERC-20 and ERC-721 assets.
40+
## Controller Web Integration
1941

20-
## /Achievements
42+
- [React](https://docs.cartridge.gg/controller/examples/react): Integrate Cartridge Controller into a React application.
43+
- [Svelte](https://docs.cartridge.gg/controller/examples/svelte): Integrate Cartridge Controller into a Svelte application.
2144

22-
- [Setup](https://docs.cartridge.gg/controller/achievements/setup): Learn how to set up and configure the Cartridge Achievement system in your game, including dependency management and Torii configuration.
23-
- [Achievement Creation](https://docs.cartridge.gg/controller/achievements/creation): Learn how to create and define achievements in your game using Cartridge's achievement system, including task definitions and metadata configuration.
24-
- [Achievement Progression](https://docs.cartridge.gg/controller/achievements/progression): Learn how to implement achievement progression tracking in your game using Cartridge's event-based system and API.
25-
- [Integration](https://docs.cartridge.gg/controller/achievements/integration): Learn how to integrate Cartridge's Achievement system into your game client, including controller configuration and UI components.
26-
- [Achievement Testing](https://docs.cartridge.gg/controller/achievements/testing): Learn how to properly test achievement functionality in your game by setting up the required event definitions and test environment.
45+
## Controller Native Integration
2746

28-
## /vRNG
47+
- [Overview](https://docs.cartridge.gg/controller/native/overview): Choose the right connection flow for native and mobile applications.
48+
- [React Native](https://docs.cartridge.gg/controller/native/react-native): Integrate Controller into React Native applications using TurboModules.
49+
- [Android](https://docs.cartridge.gg/controller/native/android): Integrate Controller into Android applications using Kotlin and UniFFI bindings.
50+
- [iOS](https://docs.cartridge.gg/controller/native/ios): Integrate Controller into iOS applications using Swift and UniFFI bindings.
51+
- [Capacitor](https://docs.cartridge.gg/controller/native/capacitor): Wrap your web app for native distribution using Capacitor and SessionConnector.
52+
- [Headless Controller](https://docs.cartridge.gg/controller/native/headless): User-supplied signing keys for server-side and automated applications.
53+
- [Session URL Reference](https://docs.cartridge.gg/controller/native/session-flow): URL format, parameters, and callback metadata for the browser-based session flow.
2954

30-
- [Overview](https://docs.cartridge.gg/vrf/overview): Explore Cartridge's Verifiable Random Number Generator (vRNG), a system designed to provide cheap, atomic, and verifiable randomness for fully onchain games.
55+
## Controller Other Integrations
3156

57+
- [CLI](https://docs.cartridge.gg/controller/examples/cli): Execute Starknet transactions from the command line using Controller sessions.
58+
- [Node](https://docs.cartridge.gg/controller/examples/node): Integrate Cartridge Controller into a Node.js application.
59+
- [Rust](https://docs.cartridge.gg/controller/examples/rust): Integrate Cartridge Controller into a Rust application.
60+
- [Telegram](https://docs.cartridge.gg/controller/examples/telegram): Integrate Cartridge Controller into a Telegram Mini App.
3261

33-
## /controller/examples
62+
## Arcade
3463

35-
- [Cartridge Controller React Integration](https://docs.cartridge.gg/controller/examples/react): Learn how to integrate the Cartridge Controller into your React application, including setup, configuration, and usage examples.
36-
- [Svelte](https://docs.cartridge.gg/controller/examples/svelte): Learn how to integrate the Cartridge Controller into your Svelte application, including setup, configuration, and usage examples.
37-
- [Rust](https://docs.cartridge.gg/controller/examples/rust): Learn how to integrate the Cartridge Controller into your Rust application, including setup, configuration, and usage examples.
38-
- [Cartridge Controller Node.js Integration](https://docs.cartridge.gg/controller/examples/node): Learn how to integrate the Cartridge Controller into your Node.js application, including setup, configuration, and usage examples.
39-
- [Telegram](https://docs.cartridge.gg/controller/examples/telegram): Learn how to integrate the Cartridge Controller into your Telegram Mini App, including setup, configuration, and usage examples.
64+
- [Overview](https://docs.cartridge.gg/arcade/overview): The ultimate hub for onchain games with permissionless game registration and player engagement.
65+
- [Setup](https://docs.cartridge.gg/arcade/setup): Register, configure, and index your game with Arcade.
66+
- [Marketplace](https://docs.cartridge.gg/arcade/marketplace): Set up your game's Marketplace for onchain assets.
4067

41-
## /slot
68+
## Slot
4269

43-
- [Getting Started](https://docs.cartridge.gg/slot/getting-started): Get started with Slot, the execution layer of Dojo that provides low latency, dedicated, provable execution contexts for blockchain applications.
44-
- [Scale your deployments](https://docs.cartridge.gg/slot/scale): Scale your slot deployments by leveraging cartridge Infrastructure
70+
- [Getting Started](https://docs.cartridge.gg/slot/getting-started): Get started with Slot, providing low latency, dedicated, provable execution contexts.
71+
- [Billing](https://docs.cartridge.gg/slot/billing): Manage billing for Slot services through team-based credit management.
72+
- [Scale](https://docs.cartridge.gg/slot/scale): Scale your Slot deployments by upgrading to paid instances.
73+
- [Paymaster](https://docs.cartridge.gg/slot/paymaster): Manage Slot paymasters to sponsor transaction fees for your applications.
74+
- [vRNG](https://docs.cartridge.gg/slot/vrng): Verifiable Random Number Generator for cheap, atomic, and verifiable onchain randomness.
75+
- [RPC](https://docs.cartridge.gg/slot/rpc): Cartridge RPC endpoints for Starknet mainnet and Sepolia testnet.
76+
- [Observability](https://docs.cartridge.gg/slot/observability): Monitor deployments with integrated Prometheus metrics and Grafana dashboards.

src/public/robots.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
User-agent: *
2+
Allow: /
3+
4+
# AI agent discovery
5+
# See https://llmstxt.org for the llms.txt standard

vocs.config.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@ export default defineConfig({
1010
logoUrl: "/cartridge.svg",
1111
ogImageUrl:
1212
"https://og.cartridge.gg/api/cartridge?title=%title&description=%description",
13+
aiCta: {
14+
query({ location }) {
15+
return `You are helping a developer build with Cartridge, high-performance infrastructure for provable games on Starknet. The developer is reading: ${location}. For coding agent support, install Cartridge skills: npx skills add cartridge-gg/agents`;
16+
},
17+
},
1318

1419
theme: {
1520
colorScheme: "dark",

0 commit comments

Comments
 (0)