Skip to content

Add VitePress documentation site for JasperFx#175

Merged
jeremydmiller merged 2 commits intomainfrom
docs/vitepress-documentation-site
Apr 2, 2026
Merged

Add VitePress documentation site for JasperFx#175
jeremydmiller merged 2 commits intomainfrom
docs/vitepress-documentation-site

Conversation

@jeremydmiller
Copy link
Copy Markdown
Member

Summary

  • Adds a complete VitePress documentation site with 21 pages across 5 sections
  • Orange color scheme matching the JasperFx logo
  • All C# code samples in compilable DocSamples project using mdsnippets (same pattern as Marten and Weasel)
  • Netlify deployment config targeting https://docs.jasperfx.net
  • Centralizes codegen docs previously scattered across Marten and Wolverine

Site sections

  • Getting Started — Introduction, Installation, Quick Start
  • Code Generation — Architecture overview with Mermaid diagram, Frames, Variables, MethodCall (detailed), Generated Types & Methods, Built-in Frames, codegen CLI command
  • Command Line — Setup & Integration, Writing Commands, Arguments & Flags, Environment Checks, Describe Command
  • Configuration — CritterStackDefaults, JasperFxOptions
  • Extension Methods — String, Enumerable, Reflection helpers

Infrastructure

  • docs/ — VitePress site with custom orange theme
  • src/DocSamples/ — Compilable C# project with all code samples
  • mdsnippets.json — Snippet extraction config (scans both DocSamples and source projects)
  • package.json — Root-level npm scripts (npm run docs, npm run docs-build)
  • netlify.toml — Deployment config

Test plan

  • dotnet build src/DocSamples compiles with 0 errors
  • mdsnippets injects all snippets into markdown
  • npx vitepress build docs builds with 0 errors (22 HTML pages)

🤖 Generated with Claude Code

jeremydmiller and others added 2 commits April 1, 2026 16:19
- VitePress site in docs/ with orange JasperFx-branded theme
- 21 documentation pages across 5 sections: Getting Started, Code Generation,
  Command Line, Configuration, Extension Methods
- Code Generation section with Mermaid architecture diagram, detailed
  Frame/Variable/MethodCall/GeneratedType reference pages
- Command Line section covering setup, writing commands, arguments/flags,
  environment checks, and describe command
- CritterStackDefaults and JasperFxOptions configuration docs
- Extension method reference for String, Enumerable, and Reflection helpers
- All code samples in compilable DocSamples project using mdsnippets
- Netlify deployment config targeting docs.jasperfx.net
- Root package.json with mdsnippets + concurrently for docs workflow

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Builds DocSamples, runs mdsnippets, builds VitePress, and deploys to Netlify.
Triggers on pushes to main that touch docs/, src/DocSamples/, or mdsnippets.json.
Also supports manual workflow_dispatch.

Requires NETLIFY_AUTH_TOKEN and NETLIFY_SITE_ID secrets.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@jeremydmiller jeremydmiller merged commit 9d4100b into main Apr 2, 2026
1 check 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.

1 participant