# Agent-Friendly Docs

URL: https://ship-and-scale.vercel.app/docs/agent-friendly-docs

Download the complete public manual as one Markdown file and give your coding agent reliable context about the starter.

**Agent context packet**

[Download ship-and-scale-docs.md](/ship-and-scale-docs.md): every public guide combined into one portable Markdown file.

The download excludes paid content, internal records, credentials and customer data.

The download gives an LLM the same public documentation you can read on this site, in one continuous Markdown file. It covers the starter's architecture, setup, provider configuration, authentication, workspaces, billing, email, storage, integrations, public website, deployment and operations. Headings and source URLs separate the guides so an agent can trace an answer back to the page you should review.

Use the file when you want an agent to understand the starter before it plans or changes code. It is useful in Codex, Claude Code, Cursor, ChatGPT and other tools that accept file attachments or local project context. The format is plain Markdown rather than a PDF, so code samples, commands, links and section structure stay readable to both you and the model.

## Add it to your agent [#add-it-to-your-agent]

### Download the context file [#download-the-context-file]

Select **Download complete documentation** above. Your browser saves `ship-and-scale-docs.md`. The file is generated from the current public manual, so there is no separate hand-maintained copy to drift out of date.

### Make it available to the session [#make-it-available-to-the-session]

Attach the file directly to a conversation, or place it inside the project when your coding tool reads local files. If the agent can already inspect your repository, keep the source code available too: the manual explains intended behavior and boundaries, while the checked-out files show the exact version you are editing.

### Give the agent context for future features [#give-the-agent-context-for-future-features]

Use the prompt below to orient the agent before your first feature request. The downloaded manual explains the starter; the repository's `AGENTS.md` supplies project instructions. Keep both available and ask the agent to read the relevant code for each change.

Paste this prompt at the start of your session:

<div className="intro-agent-prompt">
  ```text title="Prompt for your coding agent"
  Read ship-and-scale-docs.md and follow the repository's AGENTS.md, including relevant nested instructions. Inspect the code to understand the architecture, existing features and conventions.

  Use this context for the features I ask you to build. Read the relevant guides and code, reuse existing patterns, and flag conflicts or missing decisions before editing. Preserve workspace isolation, permissions and secret handling. Implement each requested feature, run relevant checks, and report anything unverified.

  Start with a brief summary of how the app fits together, then wait for my first feature request.
  ```
</div>

Then describe the feature you want and how it should work for your users. Repeat the context step in a new session; the prompt does not give an agent permanent memory.

## What the file does and doesn't do [#what-the-file-does-and-doesnt-do]

The download is a product manual, not a replacement for your repository. It explains how the starter fits together, which files and commands matter, and which security rules a change must keep. Your agent should still read the current code, `AGENTS.md`, package scripts and nearby tests before editing. When the manual and the code disagree, the code in your checkout is the source of truth.

The file contains only this public documentation. It has no access to your repository, environment values or provider accounts, and it can't tell your agent what's actually configured in Supabase, Stripe or Vercel. Review any files or logs you attach from your own project before sending them to an external model.

## Keep the context current [#keep-the-context-current]

Download a fresh copy after the documentation changes or when you come back to the project after an update. You can also open [`/llms-full.txt`](/llms-full.txt) to read the same text in the browser, or use **View Markdown** on any guide when you only need one topic.

For long-running work, keep the complete file as background context and attach the relevant guide again when a task needs extra focus. Ask the agent to separate what it read in the manual, what it checked in the code and what still needs confirming in your provider dashboards.