Repository navigation
Add comprehensive documentation site with Astro and Starlight - #3
Merged
Merged
Conversation
Scaffold a documentation website under docs/ built with Astro Starlight: - Twoslash-powered code blocks (expressive-code-twoslash): examples compile against the real library at build time, with hover types showing the type-level engine's actual inference - Guide pages ported from README.md (getting started, defining a grammar, schemas & types, parsing & evaluation, error handling) and an architecture page adapted from DESIGN.md - API reference generated from src/index.ts via starlight-typedoc - An interactive React playground island running safeParse/evaluateAst in the browser against the quickstart grammar - GitHub Pages deploy workflow (builds the library, then the site) The docs consume stringent via a link: dependency, so run the root build before building docs. 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.
Summary
This PR adds a complete documentation site for stringent built with Astro and Starlight, including guides, an interactive playground, and auto-generated API reference.
Key Changes
ExpressionPlayground.tsx) that demonstrates the runtime engine with live parsing and evaluation against a sample schemamainNotable Implementation Details
https://eralmansouri.github.io/stringent/via GitHub Pageshttps://claude.ai/code/session_01RhdiHwoXKWe93LDY8eFopn