diff --git a/.github/pages-redirect/index.html b/.github/pages-redirect/index.html new file mode 100644 index 000000000..a8487c0c1 --- /dev/null +++ b/.github/pages-redirect/index.html @@ -0,0 +1,44 @@ + + +
+ + + + + ++ The Beads documentation has moved to + beads.gascity.com. +
+ + + + diff --git a/.github/workflows/deploy-pages-redirect.yml b/.github/workflows/deploy-pages-redirect.yml new file mode 100644 index 000000000..7a260ab7d --- /dev/null +++ b/.github/workflows/deploy-pages-redirect.yml @@ -0,0 +1,47 @@ +name: Deploy legacy docs redirect + +on: + push: + branches: + - main + paths: + - '.github/pages-redirect/**' + - '.github/workflows/deploy-pages-redirect.yml' + workflow_dispatch: + +permissions: + contents: read + pages: write + id-token: write + +concurrency: + group: pages + cancel-in-progress: false + +jobs: + deploy: + if: ${{ github.repository == 'gastownhall/beads' }} + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v6 + with: + sparse-checkout: .github/pages-redirect + + - name: Build redirect artifact + run: | + mkdir -p _site + cp -f .github/pages-redirect/index.html _site/index.html + cp -f .github/pages-redirect/index.html _site/404.html + + - name: Upload redirect artifact + uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5 + with: + path: _site + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5 diff --git a/README.md b/README.md index 3633c71da..9fc9e4c0a 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ [](https://www.npmjs.com/package/@beads/bd) [](https://pypi.org/project/beads-mcp/) -**Docs:** https://gastownhall.github.io/beads/ +**Docs:** https://beads.gascity.com/ Beads provides a persistent, structured memory for coding agents. It replaces messy markdown plans with a dependency-aware graph, allowing agents to handle long-horizon tasks without losing context. @@ -111,7 +111,7 @@ version: sync remote-backed databases with your current `bd`, back up with migration on a remote-backed database, exactly one designated clone runs `bd migrate --force` and `bd dolt push`; other clones install the new binary and run `bd bootstrap`. See the full -[upgrade guide](https://gastownhall.github.io/beads/getting-started/upgrading) +[upgrade guide](https://beads.gascity.com/getting-started/upgrading) or [docs/getting-started/installation.md](docs/getting-started/installation.md#updating-bd). ### Security And Verification @@ -184,5 +184,5 @@ For daemon mode without git, use `bd daemon start --local` ## 📝 Documentation -* [Documentation site](https://gastownhall.github.io/beads/) (versioned) | [Installing](docs/getting-started/installation.md) | [Sync Concepts](docs/core-concepts/sync-concepts.md) | [Agent Workflow](AGENT_INSTRUCTIONS.md) | [Copilot CLI Setup](docs/integrations/copilot-cli.md) | [Copilot VS Code MCP](docs/integrations/github-copilot.md) | [Articles](ARTICLES.md) | [Sync Branch Mode](docs/reference/protected-branches.md) | [Troubleshooting](docs/reference/troubleshooting.md) | [FAQ](docs/reference/faq.md) +* [Documentation site](https://beads.gascity.com/) | [Installing](docs/getting-started/installation.md) | [Sync Concepts](docs/core-concepts/sync-concepts.md) | [Agent Workflow](AGENT_INSTRUCTIONS.md) | [Copilot CLI Setup](docs/integrations/copilot-cli.md) | [Copilot VS Code MCP](docs/integrations/github-copilot.md) | [Articles](ARTICLES.md) | [Sync Branch Mode](docs/reference/protected-branches.md) | [Troubleshooting](docs/reference/troubleshooting.md) | [FAQ](docs/reference/faq.md) * [](https://deepwiki.com/gastownhall/beads) diff --git a/docs/docs.json b/docs/docs.json index 7058fe353..b73c13da8 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -210,6 +210,10 @@ { "source": "/1.0.5/:slug*", "destination": "/:slug*" + }, + { + "source": "/1.1.0/:slug*", + "destination": "/:slug*" } ], "navigation": { diff --git a/examples/formulas/README.md b/examples/formulas/README.md index c3ae08500..7fe13a560 100644 --- a/examples/formulas/README.md +++ b/examples/formulas/README.md @@ -37,4 +37,4 @@ commands to match your project before first use. ## Creating Your Own -See the [Formulas documentation](https://gastownhall.github.io/beads/workflows/formulas) for the full reference. +See the [Formulas documentation](https://beads.gascity.com/workflows/formulas) for the full reference. diff --git a/npm-package/README.md b/npm-package/README.md index d1d8dfdca..1fd050da2 100644 --- a/npm-package/README.md +++ b/npm-package/README.md @@ -100,7 +100,7 @@ This package downloads the appropriate native binary for your platform: For complete documentation, see the [beads GitHub repository](https://github.com/gastownhall/beads): - [Complete README](https://github.com/gastownhall/beads#readme) -- [Quick Start (documentation site)](https://gastownhall.github.io/beads/getting-started/quickstart) · [in-repo source](https://github.com/gastownhall/beads/blob/main/docs/getting-started/quickstart.md) +- [Quick Start (documentation site)](https://beads.gascity.com/getting-started/quickstart) · [in-repo source](https://github.com/gastownhall/beads/blob/main/docs/getting-started/quickstart.md) - [Installation Guide](https://github.com/gastownhall/beads/blob/main/docs/getting-started/installation.md) - [FAQ](https://github.com/gastownhall/beads/blob/main/docs/reference/faq.md) - [Troubleshooting](https://github.com/gastownhall/beads/blob/main/docs/reference/troubleshooting.md) diff --git a/plugins/beads/skills/beads/commands/quickstart.md b/plugins/beads/skills/beads/commands/quickstart.md index e6a1e2679..0f554d6a6 100644 --- a/plugins/beads/skills/beads/commands/quickstart.md +++ b/plugins/beads/skills/beads/commands/quickstart.md @@ -3,7 +3,7 @@ description: Quick start guide for bd workflows (deprecated) argument-hint: [] --- -**Note:** The `bd quickstart` command is deprecated. See the [Quick Start](https://gastownhall.github.io/beads/getting-started/quickstart) on the documentation site, or the in-repo source [docs/getting-started/quickstart.md](https://github.com/gastownhall/beads/blob/main/docs/getting-started/quickstart.md). +**Note:** The `bd quickstart` command is deprecated. See the [Quick Start](https://beads.gascity.com/getting-started/quickstart) on the documentation site, or the in-repo source [docs/getting-started/quickstart.md](https://github.com/gastownhall/beads/blob/main/docs/getting-started/quickstart.md). The quickstart documentation covers: - Getting started with bd diff --git a/plugins/beads/skills/beads/resources/CLI_REFERENCE.md b/plugins/beads/skills/beads/resources/CLI_REFERENCE.md index 41e19b2db..ea24c6387 100644 --- a/plugins/beads/skills/beads/resources/CLI_REFERENCE.md +++ b/plugins/beads/skills/beads/resources/CLI_REFERENCE.md @@ -8,6 +8,6 @@ Use these live sources instead: - `bd