Repository navigation
Refresh user-facing docs for the published 0.7.0 line - #49
Merged
Merged
Conversation
The README still described the pre-npm-publish 0.4.0 state: stale version badges and status, a "What's new in v0.3" block, an @basou/sdk that is no longer type-only, and an Installation section claiming @basou/cli "is not yet published to npm" with build-from-source as the only path. Bring it in line with the published reality and basou.dev: - Bump every version string to 0.7.0. - Make npm the primary install path (build-from-source kept as the alternative), and drop the false "not yet published" / pnpm-link "published*" footnote. - Describe @basou/sdk as the read-only provenance SDK, not type-only. - Distinguish the single live-run adapter (claude-code) from native-log import (claude-code + codex). - Replace the stale per-version "What's new" block with a version-agnostic highlights list plus the existing CHANGELOG pointer. Keeps the personal-tool / pre-OSS-publish-stable framing unchanged. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The unscoped `basou` package is not published to npm (the release matrix publishes only the scoped packages), but its README led with `npm install -g basou` as a working install path and hardcoded a 0.3.1 example version. State plainly that the unscoped package is not on npm yet, point readers to `@basou/cli`, and make the version pairing version-agnostic so it stops going stale every release. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The spec described `basou session import --format json` reading from stdin and listed source-specific import as a deferred `basou session import --source <name>` form. Neither matches what shipped: `basou session import` requires `--format` and `--from <path>` (a file, not stdin), and native-log import shipped as its own `basou import <adapter>` command group (`basou import claude-code` / `basou import codex`). Correct the command form in terminal-and-import.md and cli-commands.md, and replace the "v0.2 import extensions" / deferred `--source` references with the shipped `basou import` adapters (Gemini dropped, Copilot still unimplemented). The broader v0.1/v0.2-era framing of these spec docs is left for a separate sweep. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Bring the repo's user-facing docs in line with the published 0.7.0 reality:
npm-published scoped packages, a runtime read-only SDK, and the shipped import
adapters. Docs-only; no code changes.
Why
Several docs still described the pre-npm-publish 0.4.0 state:
@basou/cliis not yetpublished to npm" claim with build-from-source as the only path, an
@basou/sdkdescribed as "type-only", a stale "What's new in v0.3" block,and a "Codex on the roadmap" line even though Codex import has shipped.
npm install -g basou, but theunscoped
basoupackage is not published (the release matrix publishes onlythe scoped packages;
npm view basouis E404), and hardcoded a0.3.1example.
basou session importdocumented as reading stdin without--from, and native-log import listed as a deferredbasou session import --sourceform when it actually shipped asbasou import claude-code/basou import codex.This PR corrects those. Version-coupled strings are made version-agnostic
where practical so they stop going stale every release. The personal-tool /
pre-OSS-publish-stable positioning is unchanged and aligned with basou.dev.
Scope (tiered)
This is the targeted pass for the README/installer/session-import staleness. A
broader repo-wide sweep of v0.x-epoch framing — CONTRIBUTING.md,
docs/spec/{overview,workspace,schemas}.md, docs/README.md,
docs/release-checklist.md, the issue templates, and the full cli-commands
catalog (missing
import/refresh/view/stats) — is intentionallydeferred to a separate follow-up.
Commits
docs: refresh the root README for the published 0.7.0 linedocs: correct the basou installer README for its npm statusdocs(spec): align session import with the shipped CLIChecklist
main.pnpm lintgreen locally (no new findings).CHANGELOG.md— N/A (docs-only; consistent with priordocs:commitsthat carried no changelog entry).
Related