Skip to content

docs: Update README / CONTRIBUTING links to basou.dev #1

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
takashi-matsuyama merged 1 commit into from
May 25, 2026
Merged

docs: Update README / CONTRIBUTING links to basou.dev #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 5 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand All @@ -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

Expand Down
15 changes: 8 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down Expand Up @@ -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
Expand All @@ -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
Loading