Corvus.Text.Json Documentation

Full documentation is available on the Corvus.Text.Json documentation website.

To build and preview the website locally:

cd docs/website
./preview.ps1

Then open http://localhost:5000 in your browser.

Source Documentation

The markdown files in this directory are the source content for the website. They are read by build.ps1 during the website build process, driven by the doc-descriptors/ YAML files.

File	Website Section
ParsedJsonDocument.md	Docs — Parsing & Reading JSON
JsonDocumentBuilder.md	Docs — Building & Mutating JSON
SourceGenerator.md	Docs — Source Generator
CodeGenerator.md	Docs — CLI Code Generation
Validator.md	Docs — Dynamic Schema Validation
SchemaEvaluator.md	Docs — Standalone Schema Evaluator
JsonPatch.md	Docs — JSON Patch, Merge Patch & Diff
JsonCanonicalization.md	Docs — JSON Canonicalization (RFC 8785)
JsonLogic.md	Docs — JsonLogic
Jsonata.md	Docs — JSONata
JMESPath.md	Docs — JMESPath
JsonPath.md	Docs — JSONPath
Toon.md	Docs — TOON Converter
MigratingFromV4ToV5.md	Docs — Migrating from V4
UsingCopilotForMigration.md	Docs — Copilot Migration
MigrationAnalyzers.md	Docs — Migration Analyzers
Analyzers.md	Docs — Analyzers

Developer & Contributor Docs

File	Description
AddingKeywords.md	How to add JSON Schema keywords to the code generation system
AnnotationSystem.md	JSON Schema annotation collection architecture
BenchmarkGuide.md	Running and maintaining benchmarks
CodeGenerationPatternDiscovery.md	How the code generator discovers common schema patterns
EcmaRegexTranslator.md	ECMAScript-to-.NET regex translator overview
EcmaRegexTranslations.md	ECMAScript regex translation reference
LocalNuGetTesting.md	Building and testing NuGet packages locally
NumericTypes.md	Numeric type system and precision model
ReleaseProcess.md	Versioning, tagging, and NuGet publishing
RunningTests.md	Test projects and how to run them
StandaloneEvaluatorInternals.md	Standalone evaluator architecture and implementation
ValidationHandlerGuide.md	How validation handlers emit C# from schema keywords

Other Content

• ExampleRecipes/ — Source for the website's Examples section (25 recipe walkthroughs)
• copilot/ — Copilot migration instructions referenced by the migration guide
• playground/ — Blazor WASM JSON Schema validation playground
• playground-jsonata/ — Blazor WASM JSONata expression playground
• playground-jsonpath/ — Blazor WASM JSONPath query playground
• playground-toon/ — Blazor WASM TOON ↔ JSON conversion playground
• playground-yaml/ — Blazor WASM YAML ↔ JSON conversion playground
• V4/ — Legacy V4 documentation (for reference during migration back to Corvus.JsonSchema)
• V4MigrationExample/ — Worked V4-to-V5 migration example
• V5Example/ — V5 usage example project
• website/ — The documentation website build pipeline and theme