Repository navigation
Simplify README and make docs landing page more enticing - #4
Merged
Merged
Conversation
README: cut deep-dive sections (pattern elements, precedence rules, error model, limits) now covered by the docs site, add badges and a "Why stringent" summary, condense the quickstart to a four-node grammar, and link out to the relevant guide pages. Landing page: add a "One grammar. Two engines." tabbed demo — the compile-time tab shows inferred result types flowing through the overloaded add node (number/string/ternary hovers) plus a real TS2345 compile error on an invalid expression via Twoslash @errors; the runtime tab quotes verbatim safeParse error objects captured from the engine. Add LinkCards to the guides, playground, architecture and API reference, and emit the TypeDoc entry page as index so /api/ resolves. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01RhdiHwoXKWe93LDY8eFopn
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.
Follow-up to #3.
README
Cut from ~280 lines to ~150 by removing the deep-dive sections (pattern-element table, precedence rules, error model, limits) that the docs site now covers, and linking to the corresponding guide pages instead — one source of truth rather than two drifting copies. Adds npm/CI/license badges, a four-bullet "Why stringent" summary, and a condensed four-node quickstart.
Docs landing page
Adds a "One grammar. Two engines." tabbed demo:
addnode (number/string/ternary hovers) and a realTS2345compile error rendered inline forparser.parse("1+'a'", {})(error code verified against the compiler, not guessed).safeParseerror objects (TYPE_MISMATCH/PARSE_ERROR/UNEXPECTED_INPUT) captured from the actual engine.Also adds a "Dive in" LinkCard row (getting started, playground, architecture, API reference) and configures TypeDoc to emit its entry page as
indexso/api/resolves instead of only/api/readme/.Verified: full docs build passes (67 pages), hovers and error spans present in the built HTML, no dead internal links.
🤖 Generated with Claude Code
https://claude.ai/code/session_01RhdiHwoXKWe93LDY8eFopn
Generated by Claude Code