-
+
Quickstart · - Documentation · - Ten-minute evaluation · + Documentation · + Ten-minute evaluation · Discord
@@ -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/). diff --git a/docs/README.md b/docs/README.md index 4193cf5..6c0208c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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 @@ -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`. diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs index 89ae41b..044a925 100644 --- a/docs/astro.config.mjs +++ b/docs/astro.config.mjs @@ -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 = [ diff --git a/docs/scripts/check-links.mjs b/docs/scripts/check-links.mjs index e4120fb..986a576 100644 --- a/docs/scripts/check-links.mjs +++ b/docs/scripts/check-links.mjs @@ -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) {