Agent skill

Orchardcore Docs Writer

by OrchardCMS in OrchardCMS/OrchardCore

Authors OrchardCore documentation — MkDocs Material pages, module README docs, nav entries, admonitions, tabbed content, and redirects.

BSD-3-ClauseAuto-check passedDevelopment

Install Orchardcore Docs Writer

skills CLI
$ npx skills add OrchardCMS/OrchardCore --skill orchardcore-docs-writer -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install OrchardCMS/OrchardCore orchardcore-docs-writer --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/OrchardCMS/OrchardCore.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/orchardcore-docs-writer .claude/skills/orchardcore-docs-writer && rm -rf skills-src

Use ~/.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/

Facts

Skill name
orchardcore-docs-writer
GitHub stars
8.2k
Token cost
~1.1k tokens
SKILL.md length
374 words
Files
2 (incl. references)
Skills in repo
16
Repo updated
First seen
Licence
BSD-3-Clause

At a glance

Authors OrchardCore documentation — MkDocs Material pages, module README docs, nav entries, admonitions, tabbed content, and redirects.

  • Works in 3 steps: Write the Markdown → Add it to the nav → Build / preview
  • The user needs to add
  • SKILL.md covers Where pages live, Workflow A: add a page to an…, Workflow B: document a new… and Markdown conventions, plus 4 more sections
  • Calls python and pip; reaches youtube-nocookie.com

What it does

Orchardcore Docs Writer is an agent skill from OrchardCMS/OrchardCore. Authors OrchardCore documentation — MkDocs Material pages, module README docs, nav entries, admonitions, tabbed content, and redirects. Use when the user needs to add or edit a docs page, document a new module, build/serve the docs site, or wire a page into the navigation.

Its SKILL.md is about 1.1k tokens, which your agent loads only when the skill is triggered. The skill folder holds 2 other files, including reference files (for example `references/docs-structure.md`).

It sits in Development, covering Static sites and blogs and Technical documentation. The repository describes itself as: Orchard Core is an open-source modular and multi-tenant application framework built with ASP.NET Core, and a content management system (CMS) built on top of that framework. The licence is BSD-3-Clause.

When your agent uses it

  • The user needs to add
  • Edit a docs page
  • Document a new module
  • Build/serve the docs site

Example prompts

  • “Use the orchardcore-docs-writer skill to author OrchardCore documentation — MkDocs Material pages, module README docs, nav entries, admonitions…”
  • “/orchardcore-docs-writer”

Requirements

  • Python 3

Workflow steps

3 steps, taken from the step headings in SKILL.md.

  1. Write the Markdown
  2. Add it to the nav
  3. Build / preview

What it can do on your machine

Read from SKILL.md and the folder at commit 545c6a0. 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:

    • python
    • pip

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    Hosts in commands or code, which the agent is likely to contact:

    • youtube-nocookie.com

    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

Orchardcore Docs Writer loads about 1.1k tokens when it runs, and up to ~2.2k if it reads all its reference files. Until then it costs about 74 tokens; SKILL.md has 374 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~74
When it runs · the whole SKILL.md, loaded when a task matches
~1.1k
With references · SKILL.md plus every file in references/, read only if the agent opens them
~2.2k

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 OrchardCMS/OrchardCore at commit 545c6a0, republished under its BSD-3-Clause licence (© OrchardCMS). 374 words, ~1,146 tokens.

Download SKILL.mdSave it as .claude/skills/orchardcore-docs-writer/SKILL.md (or your agent's skills folder). This skill also uses 1 other file; get the full folder from GitHub.
name
orchardcore-docs-writer
description
Authors OrchardCore documentation — MkDocs Material pages, module README docs, nav entries, admonitions, tabbed content, and redirects. Use when the user needs to add or edit a docs page, document a new module, build/serve the docs site, or wire a page into the navigation.

OrchardCore Docs Writer

This skill guides you through writing OrchardCore documentation following project conventions.

Docs are MkDocs + Material for MkDocs. Config: mkdocs.yml at repo root; pages live under src/docs/. The nav is explicit in mkdocs.yml — a new .md file is invisible until you add it to nav:.

Where pages live

SectionPath under src/docs/
HomeREADME.md
Getting startedgetting-started/
Guides (tutorials)guides/<name>/README.md
Key topicstopics/<topic>/README.md
Module referencereference/modules/<Name>/README.md
Releasesreleases/
Contributingcontributing/

Module name in the path drops the OrchardCore. prefix: OrchardCore.Title → reference/modules/Title/README.md.

Workflow A: add a page to an existing area

Step 1: Write the Markdown

Create the file under the right section. For a module, use the header convention:

markdown
# Title (`OrchardCore.Title`)

Short description of what the module does.

## Section
...
Step 2: Add it to the nav

Edit mkdocs.yml nav: under the matching parent. Format - Page Title: path/to/file.md:

yaml
nav:
  - Reference:
      - Modules:
          - Core Modules:
              - Display Management: reference/modules/DisplayManagement/README.md
              - My Module: reference/modules/MyModule/README.md   # added
Step 3: Build / preview
bash
pip install -r src/docs/requirements.txt   # first time (Python 3.11+)
python -m mkdocs serve                      # http://127.0.0.1:8000
python -m mkdocs build                      # static site

Workflow B: document a new module

  1. Create src/docs/reference/modules/<Name>/README.md (no OrchardCore. prefix) with the # Name (OrchardCore.Name) header.
  2. Link it from src/docs/reference/modules/README.md (the module index).
  3. Add a nav: entry in mkdocs.yml under the right category (CMS Modules / Core Modules / Content Parts / …).
  4. If it's a content part, also link from reference/modules/ContentParts/README.md.

Module docs are not auto-discovered from the manifest — every link is manual.

Markdown conventions

Admonitions
markdown
!!! note
    A neutral aside.

!!! warning
    Something that can bite.

!!! tip
    A helpful suggestion.
Tabbed content
markdown
=== "App.razor"

    ```razor
    <!DOCTYPE html>
    ```

=== "_Imports.razor"

    ```csharp
    @using System.Net.Http
    ```
Code fences

Always tag the language: ```csharp, ```json, ```bash, ```liquid.

YouTube embeds

Use privacy mode — https://www.youtube-nocookie.com/embed/<id>.

Show full SKILL.md (156 more words)Show less

Moving / renaming a page

Add a redirect so old links survive. In mkdocs.yml under plugins: redirects: redirect_maps::

yaml
redirect_maps:
  'old/path/README.md': 'new/path/README.md'

Quick Reference

Toolchain
ItemValue
GeneratorMkDocs + Material for MkDocs
Configmkdocs.yml (root)
Docs dirsrc/docs
Depssrc/docs/requirements.txt
Servepython -m mkdocs serve
Buildpython -m mkdocs build
Enabled Markdown extensions

Admonitions (!!! type), pymdownx.superfences (code), pymdownx.tabbed (=== "Tab"), pymdownx.snippets (file embed), pymdownx.tasklist, toc with permalinks.

Module header
markdown
# <Display Name> (`OrchardCore.<Id>`)

Gotchas

  • A new page must be added to nav: in mkdocs.yml or it won't appear (build warns about pages not in nav).
  • Tabbed content needs a blank line after === "Label" and 4-space indentation of the block.
  • Use repo-relative Markdown links between docs pages (../Placement/README.md), not absolute URLs.
  • When moving a page, add a redirect_maps entry — broken inbound links otherwise.
  • Match the module-header convention exactly; the docs are scanned for consistency.

References

  • references/docs-structure.md — full directory map, nav anatomy, extensions, redirects
  • src/docs/contributing/contributing-documentation.md (repo) — official guide
  • mkdocs.yml (repo root) — config + nav
  • AGENTS.md (repo root) — build commands

© OrchardCMS, BSD-3-Clause. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 1 other file (references) in .agents/skills/orchardcore-docs-writer of OrchardCMS/OrchardCore.

  • SKILL.md
  • references/docs-structure.md

Open the folder on GitHubat commit 545c6a0

Compare with similar skills

Orchardcore Docs Writer 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.

Orchardcore Docs Writer compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Orchardcore Docs Writer this skillOrchardCMS/OrchardCore8.2k—~1.1kAutomated safety check: PassBSD-3-Clause
Uui Documentationepam/UUI248—~1.3kAutomated safety check: PassMIT
Writing Commentswithastro/astro63k—~2.7kAutomated safety check: PassCustom licence
Eisland Dev Update DocsJNTMTMTM/eIsland320—~1.4kAutomated safety check: PassGPL-3.0
Eisland Dev Update DocsJNTMTMTM/eIsland320—~1.8kAutomated safety check: PassGPL-3.0
Docsccusage/ccusage19k—~261Automated safety check: PassCustom licence

Similar skills

  • Helps update UUI documentation, add doc examples, configure Property Explorer, and manage component API documentation.

    248 GitHub stars~1.3k tokensUpdated 10 days ago
    DevelopmentAuto-check passed
  • Writing Comments

    withastro/astro

    Official

    How to write JSDoc (/ /) and inline (//) comments in the Astro codebase, for contributors reading the source — not end users.

    63k GitHub stars~2.7k tokensUpdated today
    DevelopmentAuto-check passed
  • Eisland Dev Update Docs

    JNTMTMTM/eIsland

    Update or create documentation in the eIsland VuePress docs site (web/eisland-web-docs).

    320 GitHub stars~1.4k tokensUpdated today
    Agent WorkflowsAuto-check passed
  • Eisland Dev Update Docs

    JNTMTMTM/eIsland

    Update or create documentation in the eIsland VuePress docs site (web/eisland-web-docs).

    320 GitHub stars~1.8k tokensUpdated today
    Agent WorkflowsAuto-check passed
  • Docs

    ccusage/ccusage

    Routes ccusage documentation impact work. An agent skill from ccusage/ccusage.

    19k GitHub stars~261 tokensUpdated today
    DevelopmentAuto-check passed
  • 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).

    199 GitHub stars~1.3k tokensUpdated today
    DevelopmentAuto-check passed

More from OrchardCMS/OrchardCore

All 16 skills in this repo
  • Orchardcore Admin Edit Views

    OrchardCMS/OrchardCore

    Creates and updates OrchardCore admin edit views using the ocat- CSS class conventions.

    8.2k GitHub stars~3.7k tokensUpdated today
    Auto-check passed
  • Orchardcore Asset Manager

    OrchardCMS/OrchardCore

    Builds, watches, and manages frontend assets in OrchardCore.

    8.2k GitHub stars~1.5k tokensUpdated today
    Auto-check passed
  • Orchardcore Data Migration

    OrchardCMS/OrchardCore

    Creates and updates OrchardCore data migrations (DataMigration classes with CreateAsync/UpdateFromX).

    8.2k GitHub stars~1.7k tokensUpdated today
    Auto-check passed
  • Orchardcore Display Management

    OrchardCMS/OrchardCore

    Controls how OrchardCore renders content — placement.json rules, display drivers, shapes, zones, alternates, and editor groupings (tabs/cards/columns).

    8.2k GitHub stars~1.8k tokensUpdated today
    Auto-check passed
  • Orchardcore Localization

    OrchardCMS/OrchardCore

    Localizes OrchardCore apps — UI strings (IStringLocalizer/IViewLocalizer S, T, H), PO files and pluralization, content translation (LocalizationPart, culture picker), and supported-culture…

    8.2k GitHub stars~1.7k tokensUpdated today
    Auto-check passed
  • Orchardcore Module Creator

    OrchardCMS/OrchardCore

    Creates new OrchardCore modules with proper structure, manifest, startup, and patterns.

    8.2k GitHub stars~1.1k tokensUpdated today
    Auto-check passed

Questions about Orchardcore Docs Writer

What does Orchardcore Docs Writer do?

Authors OrchardCore documentation — MkDocs Material pages, module README docs, nav entries, admonitions, tabbed content, and redirects. Orchardcore Docs Writer is an agent skill from OrchardCMS/OrchardCore. Authors OrchardCore documentation — MkDocs Material pages, module README docs, nav entries, admonitions, tabbed content, and redirects.

When should I use Orchardcore Docs Writer?

Orchardcore Docs Writer fits situations like: the user needs to add; edit a docs page; document a new module; build/serve the docs site.

How do I install Orchardcore Docs Writer in Claude Code?

Run `npx skills add OrchardCMS/OrchardCore --skill orchardcore-docs-writer -a claude-code`. Or copy the skill folder (.agents/skills/orchardcore-docs-writer in OrchardCMS/OrchardCore) into .claude/skills/orchardcore-docs-writer in your project. Claude Code loads it when a task matches its description.

How do I install Orchardcore Docs Writer in Codex?

Run `npx skills add OrchardCMS/OrchardCore --skill orchardcore-docs-writer -a codex`. Or copy the skill folder (.agents/skills/orchardcore-docs-writer in OrchardCMS/OrchardCore) into .agents/skills/orchardcore-docs-writer in your project. Codex loads it when a task matches its description.

Can I use Orchardcore Docs Writer 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 OrchardCMS/OrchardCore --skill orchardcore-docs-writer -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/orchardcore-docs-writer, .gemini/skills/orchardcore-docs-writer, .github/skills/orchardcore-docs-writer and .opencode/skills/orchardcore-docs-writer in your project.

What does Orchardcore Docs Writer need to run?

Going by SKILL.md and its folder, Orchardcore Docs Writer needs the command-line tools its instructions call (python and pip). Our summary lists: Python 3.

Does Orchardcore Docs Writer access the network?

SKILL.md names 1 domain. In commands or code: youtube-nocookie.com; the agent is likely to contact it when it follows the instructions. This is read from the text; nothing was executed.

Is Orchardcore Docs Writer 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 Orchardcore Docs Writer use?

Orchardcore Docs Writer is published under the BSD-3-Clause licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Orchardcore Docs Writer use?

About 1.1k tokens (SKILL.md is roughly 4.6k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 1.1k tokens, read only when the agent opens those files.

What are the alternatives to Orchardcore Docs Writer?

Skills that share tags, products or a category with Orchardcore Docs Writer: Uui Documentation (epam/UUI, 248 stars), Writing Comments (withastro/astro, 63k stars), Eisland Dev Update Docs (JNTMTMTM/eIsland, 320 stars) and Eisland Dev Update Docs (JNTMTMTM/eIsland, 320 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Orchardcore Docs Writer?

OrchardCMS (a GitHub organization) maintains it in OrchardCMS/OrchardCore, which has 8,195 GitHub stars. The repository holds 16 skills in this directory. The repository was last updated on October 9, 2026.

Source: OrchardCMS/OrchardCore on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.