Docs-accuracy audit: parser conformance + doc corrections - #148
Merged
Conversation
JSONOutputParser decoded "vee" but never compared it to the declared version, so any object with a "vee" key — including a mismatched version — was treated as JSON opt-in instead of falling back to text. WidgetCardParser never read "vee_widget" at all, though the schema and docs mark it required. Both now match the schema: an object missing or disagreeing on the version is rejected (JSON falls back to text parsing; a widget card is rejected with a diagnostic).
…actions, and Node - params.json: trim/emojize are on by default like ansi; regenerate the generated params table. - charts.md: accessory precedence is first-wins (progress > sparkline > share chart), not last-wins. - json-output.md: accessoryWidth also sizes a slider, matching the params table. - debugging.md: a streaming plugin's stderr is captured (bounded tail) and surfaced in the restart message, not discarded. - cli-and-urls.md: enableplugin/disableplugin/toggleplugin and an href-carrying notify pop a confirmation dialog when triggered via a deep link. - faq.md: TypeScript's floor is Node >= 22.18 (type stripping), not 24+.
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.
Deep docs-vs-source audit findings. Parser: JSON opt-in now requires
"vee": 1exactly (else text fallback, as documented); widget cards now requirevee_widget: 1per the published schema (with diagnostic; catalog plugins verified compliant). Docs: trim/emojize defaults in the params table, charts.md precedence wording, accessoryWidth slider mention, streaming-stderr claim in debugging.md, deep-link confirmation notes in cli-and-urls.md, Node floor in faq.md. Full gate + docs guards green.