umbraco-docs-content

Standardize Umbraco documentation content with style guide and markdown conventions.

290|826|Updated Jun 15, 2012
One-click install
npx skills add https://github.com/umbraco/UmbracoDocs --skill umbraco-docs-content
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: umbraco-docs-content
Source: https://github.com/umbraco/UmbracoDocs/tree/main/.claude/skills/umbraco-docs-content
Command: npx skills add https://github.com/umbraco/UmbracoDocs --skill umbraco-docs-content

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Guidelines for creating and editing Umbraco documentation content. Use when writing new articles, editing existing docs, or making structural changes (adding, moving, renaming, deleting articles). Covers style guide, markdown conventions, code samples, images, SUMMARY.md entries, and .gitbook.yaml redirects.

Core Features & Use Cases

  • Style guide and markdown conventions
  • Code samples and images
  • File structure and SUMMARY.md management
  • Redirects when moving or renaming articles
  • Image management in .gitbook/assets

Quick Start

Follow the style guide to draft or update Umbraco documentation, ensuring proper structure, links, and redirects.

Frequently Asked Questions about umbraco-docs-content

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I standardize Umbraco documentation to follow a consistent style guide?

To standardize Umbraco documentation, apply the enforced style guide and markdown conventions when drafting or editing articles. This ensures consistent quality across new articles, existing doc updates, and structural changes.

What is the correct way to manage redirects when renaming or moving Umbraco articles?

Managing redirects when moving Umbraco articles requires updating the .gitbook.yaml file. This process ensures readers are automatically redirected from old article paths to the new locations without breaking existing links.

How do I add a new article to the SUMMARY.md file in Umbraco docs?

Adding a new article to Umbraco docs requires creating an entry in the SUMMARY.md file. This management step registers the new markdown document within the documentation structure so it appears in the table of contents.

What markdown conventions should I follow when writing code samples in Umbraco documentation?

Writing code samples in Umbraco documentation requires following specific markdown conventions outlined in the style guide. This formatting ensures code blocks render correctly and consistently across all documentation articles.

How do I handle image management when updating Umbraco documentation?

Image management in Umbraco documentation involves storing files in the .gitbook/assets directory. Following the style guide for image handling ensures visual assets render correctly within the markdown article structure.

Can I use this approach to standardize content for any documentation platform, or just Umbraco?

This standardization approach is specifically tailored for Umbraco documentation. It enforces Umbraco's style guide, manages SUMMARY.md entries, and handles .gitbook.yaml redirects, making it unsuitable for unrelated documentation platforms.