> 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/deployment.md).

# Deployment

## Product app

The product is split into:

* FastAPI backend in `apps/api/`,
* Next.js frontend in `apps/web/`,
* optional Electron desktop shell in `apps/web/electron/`.

The backend should be launched as:

```bash
uvicorn apps.api.app:app --host 127.0.0.1 --port 8000
```

The frontend should be built from `apps/web`:

```bash
npm run build
```

Deployment-specific hosting configuration should keep the same API contracts used locally.

## Documentation deployment

Robodex is GitBook source under:

```
docs/
```

The repository root contains:

```
.gitbook.yaml
```

which points GitBook to `docs/`.

If the GitBook project is connected to this GitHub repository through Git Sync, publishing the branch that GitBook tracks is enough for GitBook to ingest the docs.

## GitHub repository link

The repository README should link to the published docs URL once the docs are published or synced.

If GitBook returns a share URL or custom site URL, use that. If the GitBook project is still private or not connected, link to the local `docs/README.md` path temporarily and replace it after sync is configured.

## Deployment caveats

The installed `gitbook` CLI is integration-oriented. Its `publish` command publishes GitBook integrations, not a legacy static docs build. Do not assume `gitbook build` exists in this CLI version.


---

# 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/deployment.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.
