> For the complete documentation index, see [llms.txt](https://robodex.gitbook.io/robodex-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://robodex.gitbook.io/robodex-docs/operations/gitbook-docs-workflow.md).

# GitBook Workflow

## Source layout

```
.gitbook.yaml
docs/
  README.md
  SUMMARY.md
  .gitbook/
    vars.yaml
  architecture/
  product/
  frontend/
  research/
  pipeline/
  operations/
  reference/
```

## Navigation

Every visible page should appear in `docs/SUMMARY.md`.

When adding a page:

1. create the Markdown file,
2. add it to `SUMMARY.md`,
3. validate the link,
4. keep the surrounding section order logical.

## GitBook components

Robodex uses GitBook-friendly Markdown:

* frontmatter descriptions,
* hints,
* cards,
* Mermaid diagrams,
* tables,
* code blocks.

Keep content useful in plain Markdown too. GitBook syntax should enhance the page, not make it unreadable outside GitBook.

## Local validation

Run:

```bash
python3 - <<'PY'
from pathlib import Path
import re

root = Path("docs")
missing = []
for match in re.finditer(r"\]\(([^)]+)\)", (root / "SUMMARY.md").read_text()):
    target = match.group(1)
    if target.startswith(("http://", "https://", "#")):
        continue
    if not (root / target).exists():
        missing.append(target)

if missing:
    raise SystemExit("Missing SUMMARY targets: " + ", ".join(missing))
print("GitBook navigation OK")
PY
```

Also run:

```bash
gitbook whoami
```

before attempting any remote GitBook action.

## Style rules

Write documentation that answers:

* where the code lives,
* what owns the behavior,
* what crosses the boundary,
* how to test it,
* what is production-ready,
* what is a scaffold or roadmap item.

Avoid vague architecture prose that cannot be traced to files.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://robodex.gitbook.io/robodex-docs/operations/gitbook-docs-workflow.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.