diff --git a/docs/STYLE.md b/docs/STYLE.md new file mode 100644 index 000000000..a378e8aae --- /dev/null +++ b/docs/STYLE.md @@ -0,0 +1,72 @@ +# Documentation style guide + +A short reference for writers and reviewers. Goal: keep voice, naming +and examples consistent across every page on this site. + +## Product naming + +| Context | Use | Don't use | +|---|---|---| +| Prose, headings, marketing | **Docker Agent** (two words, both capitalised — the proper name of the product) | docker-agent, Docker-Agent, docker agent (in prose) | +| The CLI command | `docker agent` (lower-case, two words, in monospace) | `docker-agent`, `Docker Agent run` | +| The repository / module path | `docker/docker-agent` | docker/Docker-Agent | +| Internal identifiers / package names | as defined in code (e.g. `cagent`) — never invent new spellings in prose | mixing internal identifiers into user-facing copy | + +A simple rule of thumb: +- **Talking about the product?** → "Docker Agent" +- **Showing a command the user types?** → `docker agent run agent.yaml` + +## Voice + +- Address the reader as **you**, not "we" or "the user". +- Prefer present tense and active voice ("the agent reads files", + not "files will be read by the agent"). +- Keep sentences short. Two short sentences usually beat one compound + one. +- Avoid "simply", "just", "easily" — they're rarely accurate and + often condescending. + +## Code samples + +- All shell prompts use `$ ` (dollar + space) and the command on the + same line. Output, when shown, has no prompt. +- YAML/HCL examples should be runnable as-is when reasonable, or end + in `# ...` to make truncation explicit. +- The canonical example agent uses `model: anthropic/claude-sonnet-4-5`. + Use a different model only when the example is *about* that model. +- File names in prose are in `monospace` (`agent.yaml`, not "agent.yaml"). + +## Callouts + +Use the existing pattern; the new visual style does the rest: + +```markdown +
+
When to use it
+

Body text.

+
+``` + +- `callout-info` — neutral context +- `callout-tip` — positive, "consider this" +- `callout-warning` — caution, breaking, security + +Don't prefix the title with an emoji — the icon badge already provides +one. + +## Glossary one-liners + +When a page first introduces a term, link to its concept page or use +one of these standard one-liners: + +- **Agent** — an LLM with instructions, tools, and (optionally) + sub-agents, defined in YAML or HCL. +- **Toolset** — a group of related tools the agent can call (e.g. + `filesystem`, `shell`, `mcp`). +- **MCP** — Model Context Protocol, an open standard for tool servers. +- **A2A** — Agent-to-Agent protocol, used to talk to other agents + over HTTP. +- **TUI** — Terminal User Interface, the default interactive front end + Docker Agent ships with. +- **OCI** — Open Container Initiative; the same registry format used + for Docker images. Docker Agent reuses it for sharing agents. diff --git a/docs/_config.yml b/docs/_config.yml index 469a46fe5..06fb36172 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,5 +1,6 @@ title: Docker Agent -description: Build, run, and share powerful AI agents with a declarative YAML config, rich tool ecosystem, and multi-agent orchestration — by Docker. +tagline: Run AI agents like containers. +description: Run AI agents from a YAML file. Define them once, share them through any OCI registry, and run them anywhere — by Docker. url: "https://docker.github.io" baseurl: "/docker-agent" @@ -25,6 +26,7 @@ relative_links: exclude: - DEVELOPMENT.md - TODO.md + - STYLE.md - recordings/ - Gemfile - Gemfile.lock diff --git a/docs/_includes/docker-bar.html b/docs/_includes/docker-bar.html new file mode 100644 index 000000000..eb5e75c8d --- /dev/null +++ b/docs/_includes/docker-bar.html @@ -0,0 +1,17 @@ + + diff --git a/docs/_includes/footer.html b/docs/_includes/footer.html new file mode 100644 index 000000000..5f1c89704 --- /dev/null +++ b/docs/_includes/footer.html @@ -0,0 +1,45 @@ + diff --git a/docs/_includes/header.html b/docs/_includes/header.html index 210417cc5..2c817ce99 100644 --- a/docs/_includes/header.html +++ b/docs/_includes/header.html @@ -2,13 +2,9 @@