Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ jobs:
run: npm run build
working-directory: docs
env:
PUBLIC_DOCS_SITE: https://brokkai.github.io
PUBLIC_DOCS_BASE: /anvil
PUBLIC_DOCS_SITE: https://anvil.brokk.ai
PUBLIC_DOCS_BASE: /

- name: Prepare Pages artifact
run: touch docs/dist/.nojekyll
Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<h1 align="center">Anvil</h1>

<p align="center">
<a href="https://brokkai.github.io/anvil/">
<a href="https://anvil.brokk.ai/">
<img src="docs/public/anvil-social-card.png" alt="Anvil — one portable agent runtime for your ACP interface" width="720">
</a>
</p>
Expand All @@ -15,8 +15,8 @@

<p align="center">
<a href="#install-and-evaluate">Quickstart</a> ·
<a href="https://brokkai.github.io/anvil/">Documentation</a> ·
<a href="https://brokkai.github.io/anvil/evaluate-anvil/">Ten-minute evaluation</a> ·
<a href="https://anvil.brokk.ai/">Documentation</a> ·
<a href="https://anvil.brokk.ai/evaluate-anvil/">Ten-minute evaluation</a> ·
<a href="https://discord.gg/geYkWUeH">Discord</a>
</p>

Expand Down Expand Up @@ -51,20 +51,20 @@ cargo install brokk-anvil --locked --force
anvil --version
```

Running `anvil` directly starts a stdio JSON-RPC server; use it through an ACP client. Continue with the [installation guide](https://brokkai.github.io/anvil/install/) or the reproducible [ten-minute evaluation](https://brokkai.github.io/anvil/evaluate-anvil/).
Running `anvil` directly starts a stdio JSON-RPC server; use it through an ACP client. Continue with the [installation guide](https://anvil.brokk.ai/install/) or the reproducible [ten-minute evaluation](https://anvil.brokk.ai/evaluate-anvil/).

## Supported Clients

- [Zed](https://brokkai.github.io/anvil/zed/) and [JetBrains](https://brokkai.github.io/anvil/jetbrains/) have repository-backed setup helpers and verified configuration shapes.
- [Other ACP clients](https://brokkai.github.io/anvil/other-acp-clients/) can launch Anvil as a custom stdio agent.
- The [client-building guide](https://brokkai.github.io/anvil/build-acp-client/) and `examples/` show issue triage, review, and issue-drafting automations.
- [Zed](https://anvil.brokk.ai/zed/) and [JetBrains](https://anvil.brokk.ai/jetbrains/) have repository-backed setup helpers and verified configuration shapes.
- [Other ACP clients](https://anvil.brokk.ai/other-acp-clients/) can launch Anvil as a custom stdio agent.
- The [client-building guide](https://anvil.brokk.ai/build-acp-client/) and `examples/` show issue triage, review, and issue-drafting automations.

## Documentation and Development

The [Anvil documentation](https://brokkai.github.io/anvil/) is the canonical user reference for providers, commands, tools, permissions, sessions, extensibility, and trust boundaries.
The [Anvil documentation](https://anvil.brokk.ai/) is the canonical user reference for providers, commands, tools, permissions, sessions, extensibility, and trust boundaries.

See [CONTRIBUTING.md](CONTRIBUTING.md) for source development, runtime invariants, tests, dependency-license policy, pull requests, and releases.

## License

Anvil is licensed under `LGPL-3.0-only`. See the practical [License and Use Cases](https://brokkai.github.io/anvil/license-use-cases/) guide, the controlling [LICENSE](LICENSE), and [third-party notices](https://brokkai.github.io/anvil/third-party-notices/).
Anvil is licensed under `LGPL-3.0-only`. See the practical [License and Use Cases](https://anvil.brokk.ai/license-use-cases/) guide, the controlling [LICENSE](LICENSE), and [third-party notices](https://anvil.brokk.ai/third-party-notices/).
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ npm ci
npm run dev
```

Astro serves the site at the root during local development. Production builds use the `/anvil` base path by default.
Astro serves the site at the root during local development and production. The production site is deployed to the custom domain [`https://anvil.brokk.ai`](https://anvil.brokk.ai), so its default base path is `/`.

## Validation

Expand All @@ -20,4 +20,4 @@ npm run check:evaluation
npm run build
```

The fixture check pins the documented evaluation symbols, paths, line numbers, and expected edit. The production build also checks that internal links and assets resolve under the configured deployment base. Override the production URL when necessary with `PUBLIC_DOCS_SITE` and `PUBLIC_DOCS_BASE`.
The fixture check pins the documented evaluation symbols, paths, line numbers, and expected edit. The production build also checks that internal links and assets resolve under the configured deployment base. Documentation authors can continue to use root-relative links; the Rehype base-path plugin applies a non-root deployment base when `PUBLIC_DOCS_BASE` overrides the production default. Override the production URL when necessary with `PUBLIC_DOCS_SITE` and `PUBLIC_DOCS_BASE`.
4 changes: 2 additions & 2 deletions docs/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ import starlight from '@astrojs/starlight';
import { defineConfig } from 'astro/config';
import rehypeBasePathLinks from './rehype-base-path-links.mjs';

const site = process.env.PUBLIC_DOCS_SITE ?? 'https://brokkai.github.io';
const productionBase = process.env.PUBLIC_DOCS_BASE ?? '/anvil';
const site = process.env.PUBLIC_DOCS_SITE ?? 'https://anvil.brokk.ai';
const productionBase = process.env.PUBLIC_DOCS_BASE ?? '/';
const isDev = process.argv.includes('dev');
const base = isDev ? '/' : productionBase;
const socialCardPath = [
Expand Down
2 changes: 1 addition & 1 deletion docs/scripts/check-links.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { normalizeBase } from '../rehype-base-path-links.mjs';

const docsRoot = fileURLToPath(new URL('..', import.meta.url));
const distRoot = join(docsRoot, 'dist');
const base = normalizeBase(process.env.PUBLIC_DOCS_BASE ?? '/anvil');
const base = normalizeBase(process.env.PUBLIC_DOCS_BASE ?? '/');
const origin = 'https://docs.invalid';

function walkFiles(directory) {
Expand Down
Loading