Rewrote the docs in a warmer voice, added 'kbd' key markup, switched to US spelling, and completed the key-bindings reference.#116
Merged
Conversation
…g and completed the key-bindings reference with the full action, key and default-binding surface.
This comment has been minimized.
This comment has been minimized.
|
Warning Review limit reachedYou’ve reached a temporary PR review limit under our Fair Usage Limits Policy. Next review available in: 19 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (31)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
This comment has been minimized.
This comment has been minimized.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #116 +/- ##
=======================================
Coverage 98.21% 98.21%
=======================================
Files 100 100
Lines 3358 3358
=======================================
Hits 3298 3298
Misses 60 60 ☔ View full report in Codecov by Harness. |
This comment has been minimized.
This comment has been minimized.
|
🎉 Published on https://tui-docs.netlify.app as production |
AlexSkrypnyk
added
the
Needs review
AlexSkrypnyk
added
the
Needs review
|
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
1 participant
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
This PR overhauls the documentation site and README for tone, accessibility and completeness. Every page under
docs/content/is rewritten into a warmer, more direct technical-writing voice that addresses the reader as "you" instead of "the consumer" or "the caller". Keyboard keys are marked up with<kbd>tags across every docs page and the README's widget cards, replacing bare backticks or plain key names. The docs and README switch to US English spelling throughout prose, while identifiers, URLs and code samples stay exactly as the code spells them. The key-bindings reference page gets a completeness pass verified againstsrc/Input/: a fullActioninventory, everyKeyNamecase, all scope forms including themultiple:variant, tables of the actualdefaultandvimpreset bindings, theKey::char()binding form, and a correction on the calendar page distinguishing fixed keys from remappable ones.Changes
Voice rewrite
docs/content/*.mdxpages andREADME.mdinto a warmer, more direct voice: second person ("you" / "your code") replaces "the consumer" / "the caller", contractions appear naturally, and long clause-stacked sentences are split into shorter ones (for examplearchitecture.mdxandpanels.mdx, each broken into multiple paragraphs).Keyboard key markup
<kbd>tags across the docs key-bindings tables, the panels/widgets prose, and the README's widget-card key hints, replacing bare backticks or plain text (for example "Space picks an item up" becomes "Space picks an item up").US English spelling
behaviourtobehavior,colourtocolor,centretocenter,greytogray,labelledtolabeled,normalisationtonormalization,acknowledgementtoacknowledgment, and matching updates to page titles, frontmatter descriptions and keywords (for examplefield-behaviour.mdx's title changes from "Field behaviour" to "Field behavior").field-behaviour.mdxfilename and its/field-behaviourroute are unchanged).Key-bindings reference completeness
Actionenum case with its meaning, plus everyKeyNamecase.defaultpreset bindings scope by scope (base, navigation, number, text, textarea, confirm, toggle, password, pause, select/search including themultiple:scope, file picker, reorder).vimpreset's additions and theKey::char()binding form (for example howCtrl-Eis bound).docs/content/widgets/calendar.mdx: replaced the blanket claim "Every move key can be remapped" with an accurate split - day/week moves and the vim letters resolve through the key map and can be remapped, while the month and edge jumps (PageUp/PageDown,Home/End) are fixed keys with no action behind them.Screenshots
N/A - this change touches only Markdown/MDX documentation prose and the README; no templates, styles, or rendered UI changed.
Before / After