Skip to content

Simplify README and make docs landing page more enticing - #4

Merged
eralmansouri merged 1 commit into
mainfrom
claude/stringent-docs-website-tg8u1c
Jul 6, 2026
Merged

eralmansouri merged 1 commit into
mainfrom
claude/stringent-docs-website-tg8u1c

Conversation

@eralmansouri

Copy link
Copy Markdown
Owner

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:

  • Compile-time tab — Twoslash block showing inferred result types flowing through the overloaded add node (number/string/ternary hovers) and a real TS2345 compile error rendered inline for parser.parse("1+'a'", {}) (error code verified against the compiler, not guessed).
  • Runtime tab — verbatim safeParse error 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 index so /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

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
@eralmansouri
eralmansouri merged commit 50bbba7 into main Jul 6, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants