Skip to content

docs: add user-facing README sections and settings table parity - #18

Merged
Xuepoo merged 1 commit into
mainfrom
docs/user-readme-settings
Oct 20, 2026
Merged

Xuepoo merged 1 commit into
mainfrom
docs/user-readme-settings

Conversation

@Xuepoo

@Xuepoo Xuepoo commented Oct 20, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Rewrites the canonical user document (README.md) with the fixed top-level order: Overview, Install, Commands, Configuration, Keybindings, Troubleshooting. Existing scope, rules, non-goals, compat, and SDK-pin sections remain below.
  • Documents the five commands (open, move, anchor, yank, close) with their arguments, the two declared settings (row_count, max_bytes) with manifest types/defaults, and the absence of default keybindings.
  • Extends tests/settings-declarations.test.ts with a README parity assertion backed by scripts/check-readme-settings.mjs: a declared key missing from the table, an extra documented key, or a type/default mismatch fails.
  • No plugin or manifest behavior changed.

Verification

  • just check (fmt, markdownlint, metadata, hygiene, paths, manifest, Lua parse + control, 57 bun tests): pass. The local untracked .carryctx/state.db was moved aside for the hygiene gate and restored.
  • The parity test fails by construction on a removed or invented key.

Notes

  • Repo has no P2 label; used the existing P1 priority label and area:plugin.

Docs

Priority: P2 | Area: plugins | Labels: docs, P1, area:plugin

@Xuepoo Xuepoo added docs P1 area:plugin Plugin manifest and runtime surface labels Oct 20, 2026
@Xuepoo
Xuepoo merged commit 869d6aa into main Oct 20, 2026
7 checks passed
@Xuepoo
Xuepoo deleted the docs/user-readme-settings branch October 20, 2026 02:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:plugin Plugin manifest and runtime surface docs P1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant