docs-scaffold

Scaffold a Diataxis-shaped MkDocs Material docs tree in loom-managed projects.

Updated May 3, 2026
One-click install
npx skills add https://github.com/fkberthold/loom --skill docs-scaffold
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-scaffold
Source: https://github.com/fkberthold/loom/tree/main/skills/docs-scaffold
Command: npx skills add https://github.com/fkberthold/loom --skill docs-scaffold

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill scaffolds a Diataxis-shaped MkDocs Material docs tree into a loom-managed project, providing a disciplined starting point for documentation while respecting project boundaries and opt-out markers.

Core Features & Use Cases

  • Enables a Diataxis documentation structure within loom-managed projects by copying templates/diataxis and performing project-specific variable substitution.
  • Enforces per-file approval gating and opt-in invocation, preventing unwanted changes and ensuring project owners review updates.
  • Honors opt-out markers like docs/.no-diataxis and avoids scaffolding non-loom-managed repositories.

Quick Start

Invoke /docs-scaffold to generate the docs scaffold in your loom-managed project.

Frequently Asked Questions about docs-scaffold

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

FAQPage Schema
How do I scaffold a Diataxis documentation structure in a loom-managed project?

To scaffold a Diataxis documentation structure, invoke the docs-scaffold command in your loom-managed project. It copies the Diataxis templates, performs project-specific variable substitution, and prepares a per-file-diff-aware scaffold plan.

Can I prevent a Diataxis scaffold from overwriting existing documentation?

Yes, you can prevent unwanted scaffolding by adding a docs/.no-diataxis opt-out marker to your project. The scaffold detects this marker and respects the boundary, avoiding any changes to your existing documentation structure.

Does the MkDocs Diataxis scaffold require manual approval for file changes?

The MkDocs Diataxis scaffold enforces per-file approval gating, ensuring project owners review and approve updates before they are applied. This opt-in invocation prevents unwanted changes and maintains documentation integrity.

What happens if I run the docs scaffold on a non-loom-managed repository?

Running the docs scaffold on a non-loom-managed repository will not work. The skill detects project loom status first and avoids scaffolding any repositories that are not managed by loom, ensuring it only applies to valid projects.

How does the scaffold plan handle project-specific variables for MkDocs?

The scaffold plan detects required variables and performs project-specific variable substitution during the MkDocs tree generation. It prepares a per-file-diff-aware plan that copies Diataxis templates and injects the correct project variables.