Skip to content

docs: sync README + PLAN to v0.10.0, add TOC nav#13

Merged
rumitvn merged 1 commit into
mainfrom
docs/sync-readme-plan-v0.10
Jun 7, 2026
Merged

docs: sync README + PLAN to v0.10.0, add TOC nav#13
rumitvn merged 1 commit into
mainfrom
docs/sync-readme-plan-v0.10

Conversation

@rumitvn

@rumitvn rumitvn commented Jun 7, 2026

Copy link
Copy Markdown
Owner

Summary

Brings all top-level docs in sync with the current v0.10.0 release and adds a claude-mem-style table-of-contents nav to the README.

  • README.md

    • Added a centered TOC nav (Why · Install · Everyday use · Team memory · Dashboard · Cross-tool · MCP tools · CLI · License).
    • Added a bold headline callout under the intro pointing at the team-memory feature (no server / no API keys / no GitHub required).
    • Rewrote the stale Status section — it said v0.2; now reads v0.10.0 / 366 tests / Node 20 + 22 with a version-history table (v0.1 → v0.10).
  • README.vi.md (was significantly behind — brought to full parity)

    • CI / npm / license badges, TOC nav + headline callout (Vietnamese labels).
    • MCP tools table 5 → 7 (export_memory, get_share_status) + export explainer.
    • Added missing Team memory and Cross-clone sections, team-sharing CLI commands, and a translated Status table.
  • PLAN.md → rewritten as a clean roadmap/status index (current version, version→theme→phase-SSOT table, architecture snapshot, conventions). The PLAN-PHASE2…7.md files are untouched and linked.

  • CLAUDE.md → phase-SSOT chain updated through Phase 7 (v0.10.0).

Test plan

  • pnpm format:check (prettier covers all Markdown) — green
  • Docs-only change; no code touched.

- README.md: add centered TOC nav (Why · Install · Everyday use · Team
  memory · Dashboard · Cross-tool · MCP tools · CLI · License), bold
  headline callout, rewrite stale Status section (v0.2 → v0.10.0) with a
  version-history table.
- README.vi.md: bring to full parity — badges, TOC + headline, 7 MCP
  tools (export_memory + get_share_status), Team memory + Cross-clone
  sections, team-sharing CLI commands, v0.1→v0.10 Status table.
- PLAN.md: rewrite as a clean roadmap/status index (phase SSOTs kept
  untouched and linked).
- CLAUDE.md: update phase-SSOT chain through Phase 7 (v0.10.0).
@rumitvn rumitvn merged commit 036dc74 into main Jun 7, 2026
2 checks passed
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.

2 participants