new-doc

Generate Pulumi documentation pages with YAML frontmatter and menu structure.

178|268|Updated Sep 21, 2017
One-click install
npx skills add https://github.com/pulumi/docs --skill new-doc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: new-doc
Source: https://github.com/pulumi/docs/tree/main/.claude/commands/new-doc
Command: npx skills add https://github.com/pulumi/docs --skill new-doc

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill streamlines the creation of new documentation pages within the Pulumi Docs site, ensuring consistency in structure, frontmatter, and discoverability.

Core Features & Use Cases

  • Guided Workflow: Walks users through a 7-step process for creating new documentation.
  • Automated Metadata Generation: Calculates menu weights, identifiers, and suggests meta images.
  • Content Stubbing: Creates a basic file structure with placeholders for content.
  • Use Case: A new engineer needs to add a guide for a recently implemented feature. This Skill ensures the guide is placed correctly, has all necessary metadata for SEO and navigation, and follows the established documentation standards.

Quick Start

Use the new-doc skill to create a new documentation page about Pulumi Deployments.

Frequently Asked Questions about new-doc

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

FAQPage Schema
How do I create new Pulumi documentation pages with proper YAML frontmatter?

To create Pulumi documentation pages with proper YAML frontmatter, use a guided 7-step workflow that gathers content context, calculates menu weights, generates SEO metadata, and validates the final Hugo markdown file structure.

What's the best way to add a new guide to the Pulumi Docs site without breaking navigation?

The best way to add a guide to the Pulumi Docs site without breaking navigation is to automate menu weight calculation and metadata generation, ensuring the new page integrates correctly into the existing Hugo menu structure and is discoverable.

Does this documentation workflow support creating both index pages and regular content stubs?

Yes, this documentation workflow supports creating both regular pages and index pages, offering options to generate either a basic file structure with content placeholders or a full draft of the documentation.

Can I generate SEO-optimized metadata automatically when writing Hugo markdown for Pulumi?

Yes, you can generate SEO-optimized metadata automatically when writing Hugo markdown for Pulumi. The workflow calculates menu weights, identifiers, and suggests meta images to ensure the documentation meets established SEO and navigation standards.

Why do I need a 7-step process to generate documentation files for Pulumi?

A 7-step process is needed to generate documentation files for Pulumi because it interactively gathers context, checks for existing docs, navigates directories, collects content details, calculates menu weights, generates metadata, and creates the file to ensure structural consistency.

Are there limitations when creating content stubs for Pulumi documentation?

When creating content stubs for Pulumi documentation, the primary limitation is that the output is a basic file structure with placeholders for content, meaning you must manually write the actual documentation content after the metadata and file generation is complete.