docs: add usage-focused documentation and rewrite README for the xspe… - #1
Merged
Conversation
…c product Add a docs/ directory with a usage guide for xspec: getting started, spec-authoring syntax, configuration reference, TypeScript integration, CLI reference, and workflow guides for coverage, impact analysis, review sessions, identity-preserving refactoring, and workspace files. All command output shown was captured from the built CLI running against a demo workspace, and consumer typecheck/runtime setups were verified with tsc and Node. Rewrite README.md to describe the xspec product (this repository is now its home), link into docs/, and retain SDG development context. Co-Authored-By: Claude Fable 5 <[email protected]> Claude-Session: https://claude.ai/code/session_01DmJEb7hcEa9iaQw5v6KoJy
The site (Next.js + Fumadocs) renders the Markdown files in docs/ with no separate content copy: docs/README.md is served as the /docs index via a custom slug mapping, sidebar order comes from docs/meta.json, and relative .md links between pages resolve through Fumadocs' relative-link handling. To serve both GitHub and the site from the same files, each page gains frontmatter (title, description) while keeping its leading H1 for GitHub; a remark plugin strips that heading at compile time so pages don't render it twice. Relative links are normalized to ./-prefixed form (required by the resolver, identical on GitHub), the one link out of docs/ now points at the GitHub blob URL, and the gitignore fence uses ini highlighting (Shiki has no gitignore grammar). Verified locally: next build prerenders all 11 pages plus llms.txt and OG routes, and the served site resolves cross-page links and anchors, strips titles correctly, orders the sidebar, and answers search queries. Run it: cd website && npm install && npm run dev Co-Authored-By: Claude Fable 5 <[email protected]> Claude-Session: https://claude.ai/code/session_01DmJEb7hcEa9iaQw5v6KoJy
…ctly" This reverts commit 04192eb66db63001bb539871fcdb01de3746ac06. The Fumadocs site lives on its own branch (claude/fumadocs-site-jfjh6s); this branch carries only the Markdown docs content and README update. Co-Authored-By: Claude Fable 5 <[email protected]> Claude-Session: https://claude.ai/code/session_01DmJEb7hcEa9iaQw5v6KoJy
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
2 participants
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.
…c product
Add a docs/ directory with a usage guide for xspec: getting started, spec-authoring syntax, configuration reference, TypeScript integration, CLI reference, and workflow guides for coverage, impact analysis, review sessions, identity-preserving refactoring, and workspace files. All command output shown was captured from the built CLI running against a demo workspace, and consumer typecheck/runtime setups were verified with tsc and Node.
Rewrite README.md to describe the xspec product (this repository is now its home), link into docs/, and retain SDG development context.
Claude-Session: https://claude.ai/code/session_01DmJEb7hcEa9iaQw5v6KoJy