Files

T

xiaomo c4d9205eb2 docs: update all documentation for node:sqlite, pnpm, proman workflow

- README: bun → pnpm, update API examples, add Node >=22.5.0 requirement
- CLAUDE.md: replace 3-phase release process with proman bump/publish
- Package READMEs: fix package names, update storage/API descriptions
- Cards: update store.md (sqlite), cli.md (db filename, remove --var-db)
- docs/sync-readme.md: update to proman workflow

2026-06-03 23:21:30 +00:00

2.6 KiB

Raw Blame History

Sync README

When updating README.md files in this monorepo, follow these conventions.

Scope

Root README.md — project overview and navigation hub
Per-package packages/*/README.md — each package self-contained

Root README Structure

The root README should have these sections in order:

Title and one-liner — content-addressed storage for JSON with schema validation
Overview — 2-3 paragraphs explaining what it does and key concepts
Architecture — dependency layer diagram (text-based)
Packages — table with ALL packages from packages/ directory, columns: Package, Description, Type (cli/lib)
Quick Start — install, build, basic usage
CLI Reference — brief command list, detailed usage in cli README
Development — pnpm install / build / check / test
Publishing — proman bump + proman publish

Per-Package README Structure

Each package README should have:

Title — package name
One-line description — matching package.json
Overview — what it does, where it sits in the architecture, dependencies
Installation — pnpm add (for libs) or "included as binary" (for cli)
API (lib packages) — all exports from src/index.ts with type signatures, grouped by category, minimal usage examples
CLI Usage (cli packages) — command reference with examples
Internal Structure — brief src/ file organization
Configuration (if applicable)

Execution Steps

Step 1: Gather current state

For each package read:

package.json (name, version, description, dependencies, bin)
src/index.ts (public API exports)
Existing README.md (preserve hand-written content worth keeping)

Step 2: Update root README

Ensure ALL packages in packages/ directory are listed in the table
Update CLI command reference from actual --help output
Keep Quick Start examples valid

Step 3: Write/update each package README

Follow the per-package structure
API section MUST match actual src/index.ts exports — never invent
For cli packages: document CLI binary name, how it is invoked
For lib packages: document exported types and functions
Internal structure: list actual files in src/

Step 4: Verify

All relative links work
Package names match package.json
No references to removed/renamed packages
pnpm run build still passes

Guidelines

Only document what src/index.ts actually exports
Root README summarizes, package READMEs go into detail
Verify CLI examples against actual commands
Preserve existing good prose when updating
English for all README content

2.6 KiB Raw Blame History