# Layout

- `cli/src/nereus/charts/nereus-reefs/`: the chart nereus-reefs (#1050): the kinds, as templates kept on uninstall, inside the CLI's package; `make chart` writes its `templates/` from `cli/src/nereus/crds/`.
- `cli/src/nereus/charts/nereus/`: the chart nereus (#1043): the namespace and the API, inside the CLI's package, installed after nereus-reefs.
- `cli/`: the CLI (ADR 0008); the `nereus` CLI, with the commands of [The CLI design](cli.md) (#409; the legacy `nereus system ...` are deprecated aliases until #410). `controllers/<name>/`: one image per Controller (`controllers/openbao/`, the `openbao-controller` image, #612; `controllers/flux/`, the `flux-controller` image, #613; `controllers/keycloak/`, the `keycloak-controller` image, #614). `api/`: the Nereus API (`nereus-api` image, #607), the server `nereus whoami` asks and the MCP clients reach at `/mcp` (ADR 0029); `nereus init` installs it. `lib/nereid/`: `nereid-sdk`, the Nereids' shared library (#754), its own package and version, built by `make nereid-sdk` into the wheel a Nereid pins. `templates/nereid/`: the Copier template of a new Nereid (#752), included by the root `copier.yml` (Copier follows a template's history only from a repository's root); `scripts/nereid/new` renders it into `controllers/<tool>/`, and `scripts/nereid/check` (`make nereid-check`, run by `make test`) holds every Nereid's `nereid-sdk` pin to the library's version. `test/scene`: the end-to-end scene on a throwaway k3d cluster; it prints how long each part took when it ends, and `test/scene-cache` keeps the public images it pulls in pull-through caches (#563). `docs/specs/`, `docs/adr/`: designs and decisions.
- `scripts/deploy/live`: takes `main` to the `live` cluster through the tailnet with `helm upgrade --install` from the published charts, then a read-only smoke test (#162, first slice; the push trigger waits for #914); `test/deploy-live-test` checks it with fakes, run by `make test`; the how-to is `docs/guides/operate/deploy-live.md`.
- `catalog/`: what Nereus says it has (#902, ADR 0016): `workload-types/`, `package-types/`, `workloads/` and `packages/`, one file per entry, registered by `nereus catalog apply --from-file catalog/`; the kinds are in `reefs/catalog/`, with no Nereid until #904.
- `images/`: the images of third-party tools that publish none Nereus can pull, built from their source at a pinned tag: `smokescreen/`, the build egress proxy (#1142).
- `deploy/install/`: the public repository `getnereus/install`'s files (#1782): `install.sh`, the one command that installs the CLI on Linux, and its GitHub Pages (`index.html`, `README.md`); `scripts/registry/cli-publish` (`make cli-publish`) builds the wheel at a tag and publishes them with its release, `test/cli-install-test` (`make cli-install-test`) installs it in a clean container.
- `deploy/ingress/`: the cluster's ingress (#728), the Gateway `ingress` (routes only from the namespaces it lists), one `HTTPRoute` per public hostname in its backend's namespace, and the `istio-gateway` release's values; linked into the CLI's package as `nereus/ingress`, whose entrance applies the Gateway and the values (#951), the routes applied by hand, a stand-in until the release reef installs manifests from git (#751) and the edge reef owns routes (#470).
- `docs/start/`, `docs/concepts/`, `docs/guides/` and `docs/reference/`: the pages a reader follows, one template per page type (`docs/agent/docs.md`, #1985). A new command, or a change to what one prints, updates the page that shows it in the same PR, with the output it really prints. `docs/walkthrough/decks/` keeps the get-started, release and edge decks, unpublished.
- `docs/reference/what-is-built.md` (what runs today), `docs/project/roadmap.md` (what comes next, the radar, the ideas being refined) and `docs/project/stand-ins.md` (the workarounds): a new capability, queued issue, idea or stand-in gets its line in the same PR.
- `docs/glossary.md`: one line per term or uncommon acronym, added in the PR that introduces it. A term the project uses (in its docs, issues or the owner's sessions) and the glossary lacks is added without asking, by a background subagent in its own git worktree (`isolation: "worktree"`), so the session's checkout and the docs server it serves stay where they are: its own `Docs` issue, a `docs/glossary-<term>` branch from `main`, the line linked to the source it credits (#332), a PR that closes the issue, merged by the subagent once the local checks pass (CI is off and the repository has no auto-merge); it reports only the PR's number and title. In messages for the owner, the first mention of an ADR carries its title.
- `sessions/`: the live sessions sketch (#223), a FastAPI server and one page, run on the owner's machine and shared with ngrok; `make sessions` runs it, `make sessions-test` tests it, and its `README.md` has the settings and the privacy rules. Its data stays outside the repository.
- `docs/presentations/`: decks as outline YAML rendered by `render-outline` into HTML (generated, never edited by hand); `make deck`, `make deck-test`.
- Generated assets are never edited by hand: `docs/assets/logo/generate` draws the logo; `docs/assets/docs/generate-landscape` draws `landscape.svg`, its planes and their capabilities under `planes.` (ported from the `wasp-idp` deck, #1490; a test keeps the committed file equal to its output); `docs/assets/docs/generate-idp-profile` draws `idp-profile.svg`.
