Skip to content

chore: back-merge main into develop #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lorem-dev merged 2 commits into from
Aug 2, 2026
Merged

chore: back-merge main into develop #4

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0970524
docs: point the README at the published documentation
lorem-dev Aug 2, 2026
08a0824
Merge pull request #3 from lorem-dev/feature/readme-doc-links
lorem-dev Aug 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ curl -fsSL https://raw.githubusercontent.com/lorem-dev/doppel/main/scripts/insta

Prebuilt binaries are published for macOS on Apple Silicon and Linux on x86-64
and arm64. Anywhere else, `cargo install --path crates/doppel-cli`. See
[the documentation](docs/usage/installation.md).
[the documentation](https://lorem-dev.github.io/doppel/usage/installation/).

Or run the image:

Expand All @@ -42,7 +42,8 @@ docker run --rm -p 8080:8080 -p 8081:8081 \
```

Published for `linux/amd64` and `linux/arm64`, with no `latest` tag -- pin the
version. See [Running in Docker](docs/usage/docker.md).
version. See
[Running in Docker](https://lorem-dev.github.io/doppel/usage/docker/).

## What it does

Expand All @@ -59,31 +60,35 @@ version. See [Running in Docker](docs/usage/docker.md).
- Serves an admin HTTP API on a second port: proxy CRUD with optimistic
concurrency, template upload, reload, a status endpoint, Prometheus metrics
and a generated Swagger UI, behind token access control. See
[the documentation](docs/usage/admin-api.md).
[the documentation](https://lorem-dev.github.io/doppel/usage/admin-api/).
- Reports errors to Sentry, optionally, behind the `sentry` cargo feature.
- Stores its configuration in a YAML file or in PostgreSQL, selected by
`--store`, with `config push` and `config pull` to move a configuration
between the two. See [the documentation](docs/usage/storage.md).
between the two. See
[the documentation](https://lorem-dev.github.io/doppel/usage/storage/).

## What it does not do yet

- No TCP proxying. A `type: tcp` proxy is rejected at load with a message
saying so, rather than being quietly ignored.

Mocked responses and Jinja2 templating are implemented -- see
[the documentation](docs/usage/mocks.md).
[the documentation](https://lorem-dev.github.io/doppel/usage/mocks/).

## Documentation

The full documentation lives in `docs/` and builds with mkdocs and the Material
theme. Python tooling here is driven by `uv`, never `pip`:
The full documentation is published at
<https://lorem-dev.github.io/doppel/>. Its source is `docs/`, and it builds
with mkdocs and the Material theme; Python tooling here is driven by `uv`,
never `pip`:

```bash
uv run --with-requirements docs/requirements.txt mkdocs serve
```

The workspace layout -- the crates, what each owns, and the dependency
direction -- is in [the architecture page](docs/development/architecture.md).
direction -- is in
[the architecture page](https://lorem-dev.github.io/doppel/development/architecture/).

`.superpowers/specs/` holds the design documents; that directory is git-ignored
and not shipped.
Expand Down