Skip to content

Sweep v0.x-epoch framing and self-contradictions out of the docs - #50

Merged
takashi-matsuyama merged 4 commits into
mainfrom
docs/sweep-v0x-epoch
Jun 9, 2026
Merged

takashi-matsuyama merged 4 commits into
mainfrom
docs/sweep-v0x-epoch

Conversation

@takashi-matsuyama

Copy link
Copy Markdown
Member

What

Repo-wide docs sweep bringing v0.x-epoch phrasing and self-contradictions in
line with the published 0.7.0 reality. This finishes the Tiered work that was
intentionally deferred during the 0.7.0 docs refresh (#49).

Scope (Hybrid)

The docs/spec corpus was pervasively written in v0.1/v0.2 epoch framing. This PR:

  • Fixes factual staleness: the codex import adapter and the richer import
    surface in overview; the multi-root capture vs. "one repository = one
    workspace" contradiction in workspace; a non-existent basou task create
    example; and the CLI catalog (which omitted import/refresh/view/stats and
    listed the non-existent session new / config).
  • De-versions pure framing and version-relative futures (v0.1/v0.2/v0.3,
    "v0.4+") to version-independent wording so the docs do not re-stale.
  • Keeps "Added in v0.2" event-catalog annotations as historical provenance,
    and leaves schema versions (0.1.0) and the dated dry-run evidence blocks
    untouched.

Commits

  1. docs(spec): refresh the CLI command catalog -> a pointer to the generated,
    always-current reference (basou.dev/commands/reference) plus a top-level
    command-group map, instead of a hand catalog that re-drifts.
  2. docs(spec): de-version the spec and correct adapter, import, and multi-root scope.
  3. docs: align contributor and release docs with the published line
    (CONTRIBUTING, README package table + --version examples, release-checklist
    published-releases backfill 0.4.0 through 0.7.0, bug_report).
  4. ci(quality): drop the stale hardcoded test-count comment.

Notes

  • Docs-only (plus one CI comment); no CHANGELOG entry, per repo convention.
  • The root README version badge and status line are intentionally kept as the
    single current-version surface; only the package table and --version
    examples were de-versioned.
  • Out of scope, flagged for follow-up: CHANGELOG.md has no 0.4.0 section even
    though 0.4.0 is published on npm.
  • Reviewed adversarially (plan stage and pre-commit) before opening.

takashi-matsuyama and others added 4 commits June 9, 2026 15:25
The hand-maintained catalog had drifted from the shipped CLI: it omitted
import, refresh, view, and stats, and listed commands that no longer exist
(session new, config). Replace the version-annotated flag-level catalog with
a top-level command-group map plus a pointer to the generated, always-current
reference at basou.dev/commands/reference (and `basou <command> --help`),
which is regenerated from the CLI on every release and cannot re-drift.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…i-root scope

The spec corpus was written in v0.1/v0.2 epoch framing that has since gone
stale. Bring it to current reality:

- overview: claude-code is no longer the only adapter (codex import shipped),
  and import is no longer JSON-only; the run adapter wraps claude-code as a
  child process while import adapters read native logs read-only.
- workspace: reconcile "one repository = one workspace" with the shipped
  multi-root capture (repeatable --project / manifest.import.source_roots,
  see terminal-and-import section 14.3); fix the stale `basou task create`
  example to `basou task new`; drop the version tag from the index-lock
  candidate (it remains unimplemented, distinct from the task/session locks).
- Drop version-coupled phrasing (v0.1/v0.2/v0.3 framing, "v0.4+" futures)
  across approval, generated-markdown, schemas, terminal-and-import, and the
  docs index, preferring version-independent wording to prevent re-staling.

The "Added in v0.2" event-catalog annotations are kept as historical
provenance. Schema versions (0.1.0) are unchanged.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
- CONTRIBUTING: replace "early pre-OSS / v0.3.x line" with version-independent
  wording (scoped @basou/* packages published, APIs still stabilizing) and
  drop the v0.1/v0.3 framing from the pathless-error note.
- README: de-version the package table and the --version examples; the version
  badge and status line remain the single intentional current-version surface.
- release-checklist: de-version the "current 0.3.1 line" lead-in and backfill
  the published-releases table with 0.4.0 through 0.7.0 (all on npm). The
  0.3.1 and 0.6.0 captured dry-run blocks stay as dated evidence.
- bug_report: drop the stale 0.3.1 version example and point the sanity-check
  reference at the canonical basou.dev URL (the local quickstart is now a
  redirect stub without that anchor).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The Test step comment hardcoded a "v0.3.1 baseline is 1015 tests" count that
has long since drifted from the suite. Replace it with a version- and
count-independent note so it does not re-stale on every test addition.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@takashi-matsuyama
takashi-matsuyama merged commit 4cb73ba into main Jun 9, 2026
7 checks passed
@takashi-matsuyama
takashi-matsuyama deleted the docs/sweep-v0x-epoch branch June 9, 2026 06:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant