From d4769984a71304884e322fe8b23b400e433c24a6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9D=BE=E5=B1=B1=E8=B2=B4=E8=87=B3?= Date: Mon, 25 May 2026 20:49:35 +0900 Subject: [PATCH] docs: Update README / CONTRIBUTING links to basou.dev The operator-facing quickstart now lives on basou.dev (the site content is bilingual and tracks the v0.3 spec). This commit points README / CONTRIBUTING at the canonical URLs rather than the docs/quickstart.md redirect stub. - README "Quickstart" reference, npm publish milestone reference, and the Project Structure inline comment now point at basou.dev/quickstart/ (or basou.dev/installation/ for the install path lookup). - CONTRIBUTING's bug-report sanity-check link and the dev-setup quickstart link follow the same pattern. - README "Links" section gains a Documentation row so readers have a direct entry point into basou.dev/getting-started/ alongside Website / GitHub / npm. docs/quickstart.md stays as a redirect stub so existing external links continue to resolve. Co-Authored-By: Claude Opus 4.7 (1M context) --- CONTRIBUTING.md | 9 +++++---- README.md | 15 ++++++++------- 2 files changed, 13 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 913272fa..59ad8563 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,9 +16,9 @@ using one of the templates: - **Bug report** — when the CLI errors out, prints something surprising, or `pnpm test` fails on a fresh checkout. Please run through the - [docs/quickstart.md](docs/quickstart.md#sanity-check-checklist) - sanity-check first — if any of those four lines fails, mention - which one in the issue title. + [Quickstart sanity-check checklist](https://basou.dev/quickstart/#sanity-check-checklist) + first — if any of those four lines fails, mention which one in + the issue title. - **Feature request / UX friction** — when something *works* but is unintuitive (e.g. `basou status` printed a confusing label, a spec section is missing, a command spelling surprised you). @@ -44,7 +44,8 @@ Prerequisites: After the first build, `pnpm --filter @basou/cli link --global` exposes a `basou` binary on your `$PATH`. The -[quickstart](docs/quickstart.md) walks through the rest end-to-end. +[quickstart](https://basou.dev/quickstart/) walks through the rest +end-to-end. ## Coding conventions diff --git a/README.md b/README.md index d779d672..a1f29ad6 100644 --- a/README.md +++ b/README.md @@ -65,8 +65,8 @@ cat .basou/handoff.md ``` For a step-by-step walkthrough with failure modes and sample output, see -[docs/quickstart.md](docs/quickstart.md). For the underlying data model, -see [docs/spec/](docs/spec/). +[basou.dev/quickstart/](https://basou.dev/quickstart/). For the +underlying data model, see [docs/spec/](docs/spec/). ## Packages @@ -77,7 +77,7 @@ see [docs/spec/](docs/spec/). | `@basou/sdk` | Type-only SDK for adapter authors | v0.3.0 — type stubs | \* published locally via `pnpm link --global`; npm publish is a planned -post-dogfood milestone (see [docs/quickstart.md](docs/quickstart.md)). +post-dogfood milestone (see [basou.dev/installation/](https://basou.dev/installation/)). ## Installation @@ -129,7 +129,7 @@ basou/ │ ├── cli/ # @basou/cli — `basou` command │ └── sdk/ # @basou/sdk — adapter SDK (type-only) ├── docs/ -│ ├── quickstart.md # 30-min walkthrough for first-time users +│ ├── quickstart.md # Redirect stub → basou.dev/quickstart/ │ └── spec/ # workspace layout, schemas, CLI surface, ... ├── apps/ # Reserved for future GUI / desktop apps ├── CHANGELOG.md @@ -142,6 +142,7 @@ Apache 2.0 — see [LICENSE](LICENSE). Copyright Basou Project Contributors. ## Links -- Website: https://basou.dev -- GitHub: https://github.com/basou-dev/basou -- npm: https://www.npmjs.com/org/basou +- Documentation: https://basou.dev/getting-started/ +- Website: https://basou.dev +- GitHub: https://github.com/basou-dev/basou +- npm: https://www.npmjs.com/org/basou