Writing Comments
withastro/astro
How to write JSDoc (/ /) and inline (//) comments in the Astro codebase, for contributors reading the source — not end users.
Build, serve, and maintain the Corvus.Text.Json documentation website and the six Blazor WASM playgrounds (JSON Schema, JSONata, JMESPath, JsonLogic, JSONPath, YAML).
Install Corvus Docs Website
$ npx skills add corvus-dotnet/Corvus.JsonSchema --skill corvus-docs-website -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install corvus-dotnet/Corvus.JsonSchema corvus-docs-website --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/corvus-dotnet/Corvus.JsonSchema.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.github/skills/corvus-docs-website .claude/skills/corvus-docs-website && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "corvus-docs-website" agent skill from https://github.com/corvus-dotnet/Corvus.JsonSchema/tree/main/.github/skills/corvus-docs-website into .claude/skills/corvus-docs-website/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "corvus-docs-website", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/corvus-dotnet/Corvus.JsonSchema/tree/main/.github/skills/corvus-docs-websiteType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add corvus-dotnet/Corvus.JsonSchema --skill corvus-docs-website -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install corvus-dotnet/Corvus.JsonSchema corvus-docs-website --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/corvus-dotnet/Corvus.JsonSchema.git skills-src && mkdir -p .agents/skills && cp -r skills-src/.github/skills/corvus-docs-website .agents/skills/corvus-docs-website && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "corvus-docs-website" agent skill from https://github.com/corvus-dotnet/Corvus.JsonSchema/tree/main/.github/skills/corvus-docs-website into .agents/skills/corvus-docs-website/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "corvus-docs-website", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add corvus-dotnet/Corvus.JsonSchema --skill corvus-docs-website -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install corvus-dotnet/Corvus.JsonSchema corvus-docs-website --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/corvus-dotnet/Corvus.JsonSchema.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/.github/skills/corvus-docs-website .cursor/skills/corvus-docs-website && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "corvus-docs-website" agent skill from https://github.com/corvus-dotnet/Corvus.JsonSchema/tree/main/.github/skills/corvus-docs-website into .cursor/skills/corvus-docs-website/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "corvus-docs-website", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/corvus-dotnet/Corvus.JsonSchema.git --path .github/skills/corvus-docs-website--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add corvus-dotnet/Corvus.JsonSchema --skill corvus-docs-website -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install corvus-dotnet/Corvus.JsonSchema corvus-docs-website --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/corvus-dotnet/Corvus.JsonSchema.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/.github/skills/corvus-docs-website .gemini/skills/corvus-docs-website && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "corvus-docs-website" agent skill from https://github.com/corvus-dotnet/Corvus.JsonSchema/tree/main/.github/skills/corvus-docs-website into .gemini/skills/corvus-docs-website/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "corvus-docs-website", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install corvus-dotnet/Corvus.JsonSchema corvus-docs-websiteInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add corvus-dotnet/Corvus.JsonSchema --skill corvus-docs-website -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/corvus-dotnet/Corvus.JsonSchema.git skills-src && mkdir -p .github/skills && cp -r skills-src/.github/skills/corvus-docs-website .github/skills/corvus-docs-website && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "corvus-docs-website" agent skill from https://github.com/corvus-dotnet/Corvus.JsonSchema/tree/main/.github/skills/corvus-docs-website into .github/skills/corvus-docs-website/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "corvus-docs-website", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add corvus-dotnet/Corvus.JsonSchema --skill corvus-docs-website -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install corvus-dotnet/Corvus.JsonSchema corvus-docs-website --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/corvus-dotnet/Corvus.JsonSchema.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/.github/skills/corvus-docs-website .opencode/skills/corvus-docs-website && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "corvus-docs-website" agent skill from https://github.com/corvus-dotnet/Corvus.JsonSchema/tree/main/.github/skills/corvus-docs-website into .opencode/skills/corvus-docs-website/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "corvus-docs-website", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
corvus-docs-website- GitHub stars
- 199
- Token cost
- ~1.3k tokens
- SKILL.md length
- 412 words
- Files
- 1
- Skills in repo
- 26
- Repo updated
- First seen
- Licence
- Apache-2.0
At a glance
Build, serve, and maintain the Corvus.Text.Json documentation website and the six Blazor WASM playgrounds (JSON Schema, JSONata, JMESPath, JsonLogic, JSONPath, YAML).
- Previewing the docs site
- SKILL.md covers Documentation Website, Playgrounds, Cross-References and CI Pipeline
- Calls npm, dotnet and npx
- Modifying website content
What it does
Corvus Docs Website is an agent skill from corvus-dotnet/Corvus.JsonSchema. Build, serve, and maintain the Corvus.Text.Json documentation website and the six Blazor WASM playgrounds (JSON Schema, JSONata, JMESPath, JsonLogic, JSONPath, YAML). Covers the 12-step build.ps1 pipeline (steps 0-11, with sub-steps), generated vs hand-authored file boundaries, incremental rebuild patterns, XmlDocToMarkdown API doc generation, SCSS/JS asset compilation, and playground startup with Monaco editor. USE FOR: building or previewing the docs site, modifying website content or theme, updating API…
Its SKILL.md is about 1.3k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.
It sits in Development, covering Technical documentation, CSS and styling and Static sites and blogs. It works with Blazor. The repository describes itself as: Support for Json Schema validation and entity generation. The licence is Apache-2.0.
When your agent uses it
- Previewing the docs site
- Modifying website content
- Updating API documentation
- Modifying playgrounds
Example prompts
- “/corvus-docs-website”
Requirements
- Node.js
What it can do on your machine
Read from SKILL.md and the folder at commit b9e3040. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
Shell commands in SKILL.md call:
npmdotnetnpx
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md. Its commands use npm and npx, which can reach the network depending on how they are called.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Context cost
Corvus Docs Website loads about 1.3k tokens when it runs. Until then it costs about 159 tokens; SKILL.md has 412 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
Safety
Auto-check passed
The automated check found no risky patterns in SKILL.md.
Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.
SKILL.md
The full file from corvus-dotnet/Corvus.JsonSchema at commit b9e3040, republished under its Apache-2.0 licence (© corvus-dotnet). 412 words, ~1,315 tokens.
Download SKILL.mdSave it as
.claude/skills/corvus-docs-website/SKILL.md (or your agent's skills folder).- name
- corvus-docs-website
- description
- Build, serve, and maintain the Corvus.Text.Json documentation website and the six Blazor WASM playgrounds (JSON Schema, JSONata, JMESPath, JsonLogic, JSONPath, YAML). Covers the 12-step build.ps1 pipeline (steps 0-11, with sub-steps), generated vs hand-authored file boundaries, incremental rebuild patterns, XmlDocToMarkdown API doc generation, SCSS/JS asset compilation, and playground startup with Monaco editor. USE FOR: building or previewing the docs site, modifying website content or theme, updating API documentation, running or modifying playgrounds. DO NOT USE FOR: library development (use other skills).
Documentation Website and Playgrounds
Documentation Website
Location
Source: docs/website/site/
Build output: docs/website/.output/
Building
cd docs\website
.\build.ps1The build script runs a 12-step pipeline (steps 0-11, with sub-steps like 1a/1b, 9b-9f) compiling content, SCSS, taxonomy, and API docs into .output/.
Serving Locally
# Preview the built site
cd docs\website
.\preview.ps1
# Or:
.\build.ps1 -ServeOnly⚠️ CRITICAL: Stop the Server Before Rebuilding
The build script deletes and recreates .output/. On Windows, the Node file server holds file locks that prevent deletion, causing the build to hang indefinitely. Always stop the serving process before running build.ps1.
Generated vs Hand-Authored Files
Auto-generated (by build.ps1, .gitignored):
site/theme/corvus/views/api/v5/index.cshtmlandv4/index.cshtmlsite/theme/corvus/views/Shared/_ApiSidebarV5.cshtmlandV4site/content/Api-v5/,site/content/Api-v4/(exceptnamespaces/andexamples/)site/taxonomy/api-v5/,site/taxonomy/api-v4/site/content/Docs/,site/content/Examples/site/taxonomy/docs/,site/taxonomy/examples/
Hand-authored (committed):
site/source/— copied into target tree by build step 0site/content/GettingStarted/,site/content/Home/site/content/Api-v5/namespaces/,site/content/Api-v5/examples/- Theme SCSS, JS, layout views
Incremental Rebuilds
| Changed | Re-run |
|---|---|
| SCSS styles | npx sass theme\corvus\assets\css\scss\main.scss .output\main.css --style=compressed --no-source-map |
| JavaScript | Copy-Item theme\corvus\assets\js\*.js .output\ |
| Content markdown | Steps 3-6 of build.ps1 |
| Library source code | dotnet build the library, then regenerate API docs |
| API page templates | Rebuild XmlDocToMarkdown tool + regenerate |
XmlDocToMarkdown Tool
Located at docs/website/tools/XmlDocToMarkdown/. Processes XML doc comments + assemblies into:
- Markdown content files
- Taxonomy YAML
- Razor views
- Per-type HTML pages
Supports multi-assembly input, versioned output with engine switcher, and per-version search indices.
Playgrounds
Six Blazor WASM playgrounds with Monaco editor integration:
| Playground | Directory | Port |
|---|---|---|
| JSON Schema | docs/playground/ | 5281 |
| JSONata | docs/playground-jsonata/ | 5280 |
| JMESPath | docs/playground-jmespath/ | — |
| JsonLogic | docs/playground-jsonlogic/ | — |
| JSONPath | docs/playground-jsonpath/ | — |
| YAML | docs/playground-yaml/ | — |
Running a Playground
# 1. Build the JS bundle (only after changing JS/Monaco assets)
cd docs\playground-jsonata
npm ci
npm run bundle
# 2. Start the Blazor WASM dev server on a fixed port
$env:ASPNETCORE_URLS = "http://127.0.0.1:5280"
dotnet run --project src\Corvus.Text.Json.Jsonata.Playground\Corvus.Text.Json.Jsonata.Playground.csprojUse ASPNETCORE_URLS env var to pin the port — --urls flag does not work with the WASM app host.
Show full SKILL.md (168 more words)Show less
SR.Format WASM Bug
SR.Format does not work correctly in Blazor WASM because System.Resources.UseSystemResourceKeys returns true, causing string.Join fallback. The EvaluationService.FixBrokenSRFormat() method compensates. All exception messages displayed to the user must go through this method.
Cross-References
- For building the library (prerequisite for API docs), see
corvus-build-and-test - See
docs/website/DEVELOPMENT.mdfor the full development guide
CI Pipeline
In CI, the website build runs as a post-compile job, in parallel with tests and packaging. This avoids adding ~13 minutes to the critical compile step.
- Compile phase (
build.ps1) — setsBUILDVAR_BuildWebsite=falseto skip the website build during the main compile. - Post-compile phase (
build-website.ps1) — restores the compile cache and runsdocs/website/build.ps1 -SkipDotNetBuild, using pre-built assemblies and XML docs from the compile phase. ReadsBUILDVAR_BasePathPrefixandBUILDVAR_IsPreviewDeploymentfrom environment variables. - Deploy jobs — download the website output artifact produced by the post-compile job.
The parallel structure is enabled by the postCompileScript input in the reusable workflow (endjin/Endjin.RecommendedPractices.GitHubActions).
For local development, run docs/website/build.ps1 directly (it builds the .NET solution as part of its pipeline unless -SkipDotNetBuild is passed).
© corvus-dotnet, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
Just SKILL.md in .github/skills/corvus-docs-website of corvus-dotnet/Corvus.JsonSchema.
Open the folder on GitHubat commit b9e3040
Compare with similar skills
Corvus Docs Website next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Corvus Docs Website this skillcorvus-dotnet/Corvus.JsonSchema | 199 | — | ~1.3k | Automated safety check: Pass | Apache-2.0 | |
| Writing Commentswithastro/astro | 63k | — | ~2.7k | Automated safety check: Pass | Custom licence | |
| Orchardcore Docs WriterOrchardCMS/OrchardCore | 8.2k | — | ~1.1k | Automated safety check: Pass | BSD-3-Clause | |
| Uui Documentationepam/UUI | 248 | — | ~1.3k | Automated safety check: Pass | MIT | |
| Docsccusage/ccusage | 19k | — | ~261 | Automated safety check: Pass | Custom licence | |
| Docs LookupProgrammerAnthony/Expert-Coding-Harness | 235 | — | ~640 | Automated safety check: Pass | MIT |
Similar skills
- Official
Orchardcore Docs Writer
OrchardCMS/OrchardCore
Authors OrchardCore documentation — MkDocs Material pages, module README docs, nav entries, admonitions, tabbed content, and redirects.
Uui Documentation
epam/UUI
Helps update UUI documentation, add doc examples, configure Property Explorer, and manage component API documentation.
Docs
ccusage/ccusage
Routes ccusage documentation impact work. An agent skill from ccusage/ccusage.
Docs Lookup
ProgrammerAnthony/Expert-Coding-Harness
通过 Context7 MCP 获取库和框架的实时最新文档，而非依赖训练数据，防止 API 幻觉。适用于查询任何库或框架的用法、配置、示例代码。触发词：怎么用、怎么配置、API参考、文档、示例代码、用法、接口、库文档、框架文档、documentation、docs、how to use、API…
DDNS VitePress Docs Maintenance
NewFuture/DDNS
Maintain DDNS VitePress documentation with bilingual parity, correct navigation and links, safe executable-doc changes, and build verification.
More from corvus-dotnet/Corvus.JsonSchema
All 26 skills in this repoCorvus Analyzers
corvus-dotnet/Corvus.JsonSchema
Understand and work with the Roslyn analyzers shipped with Corvus.Text.Json.
Corvus Benchmarks
corvus-dotnet/Corvus.JsonSchema
Run, interpret, and maintain BenchmarkDotNet benchmarks for JSON Schema validation and query languages.
Corvus Bowtie Testing
corvus-dotnet/Corvus.JsonSchema
Test Corvus.JsonSchema against the JSON Schema Test Suite using Bowtie, the cross-implementation meta-validator.
Corvus Buffer And Pooling
corvus-dotnet/Corvus.JsonSchema
Write allocation-efficient buffer code in Corvus.JsonSchema using the codebase's established three-tier pooling pattern: stackalloc → ArrayPool → ThreadStatic caches.
Corvus Bytes To Bytes
corvus-dotnet/Corvus.JsonSchema
Eliminate hand-rolled POCO record<-document string seams — types/paths that materialize a managed string (or List<string/Dictionary) between a bytes SOURCE (a parsed UTF-8 body, a DB column, a…
Corvus Codegen
corvus-dotnet/Corvus.JsonSchema
Generate strongly-typed C from JSON Schema using the Roslyn source generator or the corvusjson CLI tool.
Related
Works with
Categories
Questions about Corvus Docs Website
What does Corvus Docs Website do?
Build, serve, and maintain the Corvus.Text.Json documentation website and the six Blazor WASM playgrounds (JSON Schema, JSONata, JMESPath, JsonLogic, JSONPath, YAML). JsonSchema.Json documentation website and the six Blazor WASM playgrounds (JSON Schema, JSONata, JMESPath, JsonLogic, JSONPath, YAML).
When should I use Corvus Docs Website?
Corvus Docs Website fits situations like: previewing the docs site; modifying website content; updating API documentation; modifying playgrounds.
How do I install Corvus Docs Website in Claude Code?
Run `npx skills add corvus-dotnet/Corvus.JsonSchema --skill corvus-docs-website -a claude-code`. Or copy the skill folder (.github/skills/corvus-docs-website in corvus-dotnet/Corvus.JsonSchema) into .claude/skills/corvus-docs-website in your project. Claude Code loads it when a task matches its description.
How do I install Corvus Docs Website in Codex?
Run `npx skills add corvus-dotnet/Corvus.JsonSchema --skill corvus-docs-website -a codex`. Or copy the skill folder (.github/skills/corvus-docs-website in corvus-dotnet/Corvus.JsonSchema) into .agents/skills/corvus-docs-website in your project. Codex loads it when a task matches its description.
Can I use Corvus Docs Website in Cursor, Gemini CLI or GitHub Copilot?
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add corvus-dotnet/Corvus.JsonSchema --skill corvus-docs-website -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/corvus-docs-website, .gemini/skills/corvus-docs-website, .github/skills/corvus-docs-website and .opencode/skills/corvus-docs-website in your project.
What does Corvus Docs Website need to run?
Going by SKILL.md and its folder, Corvus Docs Website needs the command-line tools its instructions call (npm, dotnet and npx). Our summary lists: Node.js.
Does Corvus Docs Website access the network?
SKILL.md contains no URLs. Its commands use npm and npx, which can reach the network depending on how they are called. This is read from the text; nothing was executed.
Is Corvus Docs Website safe to install?
Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.
What licence does Corvus Docs Website use?
Corvus Docs Website is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does Corvus Docs Website use?
About 1.3k tokens (SKILL.md is roughly 5.3k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
What are the alternatives to Corvus Docs Website?
Skills that share tags, products or a category with Corvus Docs Website: Writing Comments (withastro/astro, 63k stars), Orchardcore Docs Writer (OrchardCMS/OrchardCore, 8.2k stars), Uui Documentation (epam/UUI, 248 stars) and Docs (ccusage/ccusage, 19k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Corvus Docs Website?
corvus-dotnet (a GitHub organization) maintains it in corvus-dotnet/Corvus.JsonSchema, which has 199 GitHub stars. The repository holds 26 skills in this directory. The repository was last updated on October 8, 2026.
Source: corvus-dotnet/Corvus.JsonSchema on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.