Skip to content

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

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, and compat sections remain below.
  • Documents the five declared chord settings (open_chord, newline, submit, close, external_editor) with manifest types/defaults, all five commands, and the suggested/in-modal bindings.
  • 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.
  • Fixes stale prose that contradicted the manifest (bitty >=0.5,<1.0, old event list, SDK pin d5d117d). No behavior change.

Verification

  • just check (fmt, markdownlint, metadata, hygiene, paths, manifest, Lua parse + control, 87 bun tests): pass.
  • 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:architecture.

Docs

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

@Xuepoo
Xuepoo merged commit dce0f07 into main Oct 20, 2026
7 checks passed
@Xuepoo
Xuepoo deleted the docs/user-readme-settings branch October 20, 2026 02:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant