Skip to content

docs: expand clipc + dv package READMEs for JSR score (#16)#32

Merged
ben-laird merged 1 commit into
mainfrom
docs/issue-16-jsr-readmes
Jun 8, 2026
Merged

docs: expand clipc + dv package READMEs for JSR score (#16)#32
ben-laird merged 1 commit into
mainfrom
docs/issue-16-jsr-readmes

Conversation

@ben-laird

Copy link
Copy Markdown
Owner

Closes #16.

Public-export JSDoc already landed in 75f93c2 (both packages pass deno task doc:lint), so the remaining JSR-score lever is the package READMEs. Both were lean one-screen pitches.

clipc README (64 → ~160 lines)

  • Core concepts section: typed routers, typed leaves, flag specs, errors-as-values, structured errors — one explainer each, plus built-in help.
  • A larger example showing nested routers + the real inheritedFlags() typed-identity-capture spread pattern (not auto-merge) + a CliError.
  • A When to use clipc section (and when @std/cli is enough).

dv README (37 → ~85 lines)

  • How it works: Records-not-commits, plugins-as-executables, two-phase release, first-class dry-run.
  • Library API section documenting the run* surface (runStatus, runVersion, …) from apps/cli/src/lib.ts vs the CLI.

Docs-only. deno task verify and deno task doc:lint pass.

🤖 Generated with Claude Code

Public-export JSDoc already landed in 75f93c2; the remaining JSR-score
lever is the package READMEs. Expand both:

- clipc: the five core concepts, a larger nested-router example using the
  real inheritedFlags spread pattern, and a "When to use" section.
- dv: how it works (Records, plugins, two-phase release, dry-run) plus a
  Library API section documenting the run* surface from lib.ts.

Docs-only; deno task verify and doc:lint stay clean.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@ben-laird ben-laird merged commit 74bec4f into main Jun 8, 2026
1 check passed
@ben-laird ben-laird deleted the docs/issue-16-jsr-readmes branch June 8, 2026 01:38
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.

@dv-cli/clipc JSR score is 52%

1 participant