new-section

Create documentation sections with overview pages and bidirectional cross-references.

78|252|Updated Feb 7, 2024
One-click install
npx skills add https://github.com/hashicorp/web-unified-docs --skill new-section
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: new-section
Source: https://github.com/hashicorp/web-unified-docs/tree/main/content/well-architected-framework/docs/.claude/skills/new-section
Command: npx skills add https://github.com/hashicorp/web-unified-docs --skill new-section

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill automates the creation of complete documentation sections, including an overview page, initial documents, and bidirectional cross-references, reducing manual setup time and ensuring consistency.

Core Features & Use Cases

  • Automated directory scaffolding for new sections with predictable structure
  • Automatic generation of index.mdx with metadata and links to all documents
  • Cross-referencing setup between section index and documents to maintain navigational integrity
  • Facilitates rapid onboarding of new product areas and reorganization efforts

Quick Start

Use the new-section skill to scaffold a basic documentation section, for example: /new-section docs/security --title "Security and Compliance"

Frequently Asked Questions about new-section

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

FAQPage Schema
How do I generate a complete documentation section with an index.mdx automatically?

To generate a documentation section automatically, use this skill to scaffold a predictable directory structure, create an index.mdx with metadata, and establish initial documents with bidirectional cross-references.

What is the best way to create bidirectional cross-references between a section index and its documents?

Creating bidirectional cross-references is best handled by automating the link generation between the section index.mdx and its initial documents, ensuring navigational integrity without manual updates.

Can I use this to scaffold directory structures for reorganizing existing repository-wide documentation?

Yes, you can use this skill to scaffold directory structures for repository-wide documentation reorganizations, rapidly onboarding new product areas while maintaining deterministic frontmatter and navigation templates.

Does this skill automatically integrate new sections with existing navigation templates?

Yes, the skill ensures integration with navigation templates by automatically generating the index.mdx with metadata and bidirectional links to maintain overall documentation navigational integrity.

How do I add frontmatter to initial documents when scaffolding a new doc section?

You add frontmatter to initial documents by running the section scaffolding command, which deterministically generates the directory structure and injects the required metadata into each file automatically.