Anydocs Documents
Quick Start

First Documentation Project

Follow the shortest path from project creation to a published preview.

This page gives you the shortest path from an empty directory to the first reachable reader page. The flow is the same whether a human or an AI is doing the work: initialize, edit, publish, preview.

1. Initialize the Project

npx @anydocs/cli init ./my-docs

If Codex or Claude Code will help author docs, add `--agent codex` or `--agent claude-code` at this step.

2. Open the Project and Confirm the Starter Content

Open `./my-docs` in Studio. Confirm the default language, welcome page, navigation, and site title before you start replacing the starter content.

3. Write a Page and Switch It to `published`

Complete the body, title, slug, and description in the editor. A page appears in the reader, search indexes, `llms.txt`, and `mcp/` artifacts only after its status becomes `published`.

4. Preview the Reader

npx @anydocs/cli preview ./my-docs

`preview` is already live by default. It prints a local URL and lands on the first published page in the default language.

If AI Helps Deliver the Site

Prefer Anydocs MCP for page creation, content updates, navigation maintenance, and status changes. Do not treat direct edits to `pages/*.json` or `navigation/*.json` as the normal workflow.

Guide File Rules

  • default without `--agent`: `skill.md`
  • `--agent codex`: `AGENTS.md`
  • `--agent claude-code`: `CLAUDE.md` and `.claude/commands/`