Use Stacklift with an LLM
You can hand these docs to ChatGPT, Claude, Cursor, Copilot or any other assistant and let it set up and run Stacklift with you: write stacklift.yaml, wire the SDK into your app, write a CI job, or build a server-driven layout.
Copy a page or all of them
- Copy for LLM, at the top of every docs page, copies that page as Markdown. The copy starts with a short description of Stacklift and the page's purpose, and every link is a full address, so the assistant understands it without the rest of the site.
- Copy all docs for LLM, on the documentation home, copies every page in one go. Use it for broad questions ("how do I ship my Flutter app with Stacklift?"). It is long, so prefer single pages when your assistant has a small context window.
- Markdown, next to the copy button, opens the page as plain Markdown in the browser.
Addresses for tools that read the web
| Address | What it is |
|---|---|
/llms.txt | An index following the llms.txt convention: what Stacklift is, and every page with a one-line summary |
/llms-full.txt | Every page in one file |
/docs/<page>.md | One page as Markdown, for example /docs/cli.md |
/api/openapi.json | The OpenAPI document: every REST endpoint with its request and response schema (/api/docs is the same, browsable) |
Give an agent the first address and it can find the rest. The pages carry a text/markdown alternate link in their HTML head as well.
Prompts that work
Paste the page (or pages), then ask. Name your stack and what you already have.
- "Using these Stacklift docs, write a
stacklift.yamland a GitHub Actions job that creates a release for my Expo app on every push to main and deploys it tostagingat 10%." (paste: CLI, stacklift.yaml, CI/CD) - "Add Stacklift update checks to my SwiftUI app. Pin the signing key and only check on launch." (paste: SDK)
- "Turn this SwiftUI screen into a stacklift-ui/1 layout, keep my current view as the fallback, and give me the JSON and the Swift code to wrap it." (paste: Server-driven UI)
- "Which of these can I update over the air in a native Android app, and which need a Play Store release?" (paste: OTA for every stack, Stack adapters)
Check what it gives you
- Commands and flags: the CLI reference is complete. If the assistant uses a flag that is not there, it made it up.
- Layouts: run
stacklift ui validate <file>before publishing. It runs the same checks as the server and names the exact problem. - Limits: the docs say plainly what is not built (for example, the iPhone widget renderer, Expo and Capacitor code push, or Flutter code push). If an answer depends on one of those, it will not work yet.
- Secrets: never paste secret keys (
slk_…), tokens or private keys into a chat. The docs never need them; use placeholders.
Writing docs that stay LLM-friendly
For contributors. Every page in docs/ is read by people and by assistants, so:
- Start with one sentence saying what the page is for, and register it in
apps/web/src/lib/docs.tswith a one-line summary (used by/llms.txt). - Make sections stand alone: name the thing again instead of "the above" or "as mentioned".
- Give exact, copyable commands, flags, file names and endpoints, with real values in examples.
- Link other pages as
/docs/<page>; the exports turn these into full addresses. - Say what is not built or not verified, in the page where it matters.