Repository navigation
docs: add user-facing README sections and settings table parity - #25
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
README.md) with the fixed top-level order: Overview, Install, Commands, Configuration, Keybindings, Troubleshooting. Existing scope, rules, non-goals, and compat sections remain below.open_chord,newline,submit,close,external_editor) with manifest types/defaults, all five commands, and the suggested/in-modal bindings.tests/settings-declarations.test.tswith a README parity assertion backed byscripts/check-readme-settings.mjs: a declared key missing from the table, an extra documented key, or a type/default mismatch fails.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.Notes
P2label; used the existingP1priority label andarea:architecture.Docs
Priority: P2 | Area: plugins | Labels: docs, P1, area:architecture