Orchardcore Docs Writer
OrchardCMS/OrchardCore
Authors OrchardCore documentation — MkDocs Material pages, module README docs, nav entries, admonitions, tabbed content, and redirects.
How to write JSDoc (/ /) and inline (//) comments in the Astro codebase, for contributors reading the source — not end users.
Install Writing Comments
$ npx skills add withastro/astro --skill writing-comments -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install withastro/astro writing-comments --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/withastro/astro.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/writing-comments .claude/skills/writing-comments && 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 "writing-comments" agent skill from https://github.com/withastro/astro/tree/main/.agents/skills/writing-comments into .claude/skills/writing-comments/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "writing-comments", 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/withastro/astro/tree/main/.agents/skills/writing-commentsType 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 withastro/astro --skill writing-comments -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install withastro/astro writing-comments --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/withastro/astro.git skills-src && mkdir -p .agents/skills && cp -r skills-src/.agents/skills/writing-comments .agents/skills/writing-comments && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "writing-comments" agent skill from https://github.com/withastro/astro/tree/main/.agents/skills/writing-comments into .agents/skills/writing-comments/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "writing-comments", 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 withastro/astro --skill writing-comments -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install withastro/astro writing-comments --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/withastro/astro.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/.agents/skills/writing-comments .cursor/skills/writing-comments && 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 "writing-comments" agent skill from https://github.com/withastro/astro/tree/main/.agents/skills/writing-comments into .cursor/skills/writing-comments/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "writing-comments", 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/withastro/astro.git --path .agents/skills/writing-comments--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 withastro/astro --skill writing-comments -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install withastro/astro writing-comments --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/withastro/astro.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/.agents/skills/writing-comments .gemini/skills/writing-comments && 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 "writing-comments" agent skill from https://github.com/withastro/astro/tree/main/.agents/skills/writing-comments into .gemini/skills/writing-comments/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "writing-comments", 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 withastro/astro writing-commentsInstalls 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 withastro/astro --skill writing-comments -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/withastro/astro.git skills-src && mkdir -p .github/skills && cp -r skills-src/.agents/skills/writing-comments .github/skills/writing-comments && 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 "writing-comments" agent skill from https://github.com/withastro/astro/tree/main/.agents/skills/writing-comments into .github/skills/writing-comments/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "writing-comments", 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 withastro/astro --skill writing-comments -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install withastro/astro writing-comments --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/withastro/astro.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/.agents/skills/writing-comments .opencode/skills/writing-comments && 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 "writing-comments" agent skill from https://github.com/withastro/astro/tree/main/.agents/skills/writing-comments into .opencode/skills/writing-comments/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "writing-comments", 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
writing-comments- GitHub stars
- 63k
- Token cost
- ~2.7k tokens
- SKILL.md length
- 1,300 words
- Files
- 2
- Skills in repo
- 10
- Repo updated
- First seen
- Licence
- Custom licence
At a glance
How to write JSDoc (/ /) and inline (//) comments in the Astro codebase, for contributors reading the source — not end users.
- Works in 2 steps: Never narrate change history. Words like… → Never address the reviewer. A comment…
- Editing comments in .ts/.js source
- SKILL.md covers Purpose, Scope Boundary, The Reader and Three Kinds of Comments, Three…, plus 8 more sections
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
What it does
Writing Comments is an agent skill from withastro/astro, published by the product's own GitHub organization. How to write JSDoc (/ /) and inline (//) comments in the Astro codebase, for contributors reading the source — not end users. Use whenever writing or editing comments in .ts/.js source, including comments added incidentally while fixing bugs or building features. Does not cover the @docs-generated config/error reference.
Its SKILL.md is about 2.7k tokens, which your agent loads only when the skill is triggered. The skill folder holds 2 other files (for example `evals/evals.json`).
It sits in Development, covering Technical documentation and Static sites and blogs. It works with Astro. The repository describes itself as: The web framework for content-driven websites.
When your agent uses it
- Editing comments in .ts/.js source
- Including comments added incidentally while fixing bugs
- Building features
Example prompts
- “/writing-comments”
Workflow steps
2 steps, taken from the first numbered list in SKILL.md.
- Never narrate change history. Words like "now", "previously", "no
- Never address the reviewer. A comment that argues your change is correct
What it can do on your machine
Read from SKILL.md and the folder at commit 28e7410. 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
No scripts in the folder and no shell commands in SKILL.md (its code samples are typescript).
From the folder's file list and the shell code blocks in SKILL.md.
Network
Links to these hosts (documentation or services it may open):
diataxis.frtsdoc.org
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
Writing Comments loads about 2.7k tokens when it runs. Until then it costs about 86 tokens; SKILL.md has 1,300 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
Its licence (Custom licence) doesn't allow us to republish the file, so here is its outline and opening line. It has 1,300 words (~2,749 tokens).
“Comments in this repository are read by contributors, months or years after they were written, with none of the context you have right now. This skill defines who that reader is, what each kind of comment is for, and which…”
- name
- writing-comments
Files
SKILL.md and 1 other file in .agents/skills/writing-comments of withastro/astro.
- SKILL.md
- evals/evals.json
Open the folder on GitHubat commit 28e7410
Compare with similar skills
Writing Comments 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 |
|---|---|---|---|---|---|---|
| Writing Comments this skillwithastro/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 | |
| Tabler Menus and Redirectstabler/tabler | 42k | — | ~1.2k | Automated safety check: Pass | MIT | |
| Uui Documentationepam/UUI | 248 | — | ~1.3k | Automated safety check: Pass | MIT | |
| Metadata Checkjdevalk/skills | 104 | — | ~1k | Automated safety check: Pass | MIT | |
| Docsccusage/ccusage | 19k | — | ~261 | Automated safety check: Pass | Custom licence |
Similar skills
Tabler Menus and Redirects
tabler/tabler
Keeps Tabler pages reachable by updating the preview menu, docs menu and redirect table whenever a page is added, renamed, moved or removed.
Uui Documentation
epam/UUI
Helps update UUI documentation, add doc examples, configure Property Explorer, and manage component API documentation.
Metadata Check
jdevalk/skills
Reviews short high-value strings — page titles, meta descriptions, schema description fields, FAQ answers, GitHub repo taglines, profile bios, social-card copy, and other metadata where Flesch and…
Docs
ccusage/ccusage
Routes ccusage documentation impact work. An agent skill from ccusage/ccusage.
Corvus Docs Website
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).
More from withastro/astro
All 10 skills in this repo- Official
Analyze GitHub Action Logs
withastro/astro
Analyze recent GitHub Actions workflow runs to identify patterns, mistakes, and improvements.
- Official
Astro Developer
withastro/astro
Comprehensive guide for developing in the Astro monorepo. An agent skill from withastro/astro.
- Official
Astro PR Writer
withastro/astro
Write and update Astro pull requests with reviewer-friendly titles and high-signal bodies.
- Official
Changeset
withastro/astro
Create a changeset for the Astro monorepo. An agent skill from withastro/astro.
- Official
Astro Code Review
withastro/astro
Perform a static, read-only code review of an Astro pull request or of a local branch, commit range, diff, patch, or working tree being prepared as a pull request.
- Official
Triagebot Action Bug Triage
withastro/astro
Takes a bug report for the triagebot-action GitHub Action through reproduction, root-cause diagnosis, an intended-behavior check and a fix attempt.
Related
Works with
Categories
Questions about Writing Comments
What does Writing Comments do?
How to write JSDoc (/ /) and inline (//) comments in the Astro codebase, for contributors reading the source — not end users. Writing Comments is an agent skill from withastro/astro, published by the product's own GitHub organization. How to write JSDoc (/ /) and inline (//) comments in the Astro codebase, for contributors reading the source — not end users.
When should I use Writing Comments?
Writing Comments fits situations like: editing comments in .ts/.js source; including comments added incidentally while fixing bugs; building features.
How do I install Writing Comments in Claude Code?
Run `npx skills add withastro/astro --skill writing-comments -a claude-code`. Or copy the skill folder (.agents/skills/writing-comments in withastro/astro) into .claude/skills/writing-comments in your project. Claude Code loads it when a task matches its description.
How do I install Writing Comments in Codex?
Run `npx skills add withastro/astro --skill writing-comments -a codex`. Or copy the skill folder (.agents/skills/writing-comments in withastro/astro) into .agents/skills/writing-comments in your project. Codex loads it when a task matches its description.
Can I use Writing Comments 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 withastro/astro --skill writing-comments -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/writing-comments, .gemini/skills/writing-comments, .github/skills/writing-comments and .opencode/skills/writing-comments in your project.
What does Writing Comments need to run?
SKILL.md names no scripts, command-line tools or credentials: Writing Comments is instructions for the agent only.
Does Writing Comments access the network?
SKILL.md names 2 domains. As links in the text: diataxis.fr and tsdoc.org. This is read from the text; nothing was executed.
Is Writing Comments 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 Writing Comments use?
Writing Comments has a licence file (the repository's licence) that doesn't match a standard licence. Read it on GitHub before reusing the skill.
How many tokens does Writing Comments use?
About 2.7k tokens (SKILL.md is roughly 11k 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 Writing Comments?
Skills that share tags, products or a category with Writing Comments: Orchardcore Docs Writer (OrchardCMS/OrchardCore, 8.2k stars), Tabler Menus and Redirects (tabler/tabler, 42k stars), Uui Documentation (epam/UUI, 248 stars) and Metadata Check (jdevalk/skills, 104 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Writing Comments?
withastro (a GitHub organization, an official publisher) maintains it in withastro/astro, which has 63,106 GitHub stars. The repository holds 10 skills in this directory. The repository was last updated on October 8, 2026.
Source: withastro/astro on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.