update-paths

Inventory WAF pillar MDX files and update CONTENT_PATHS.md.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill inventories all WAF pillar documentation files and updates CONTENT_PATHS.md with a complete, current listing.

Core Features & Use Cases

  • Scans pillar directories for .mdx files under docs/docs/ including top-level pillar subfolders.
  • Excludes templates/ and any files within template locations.
  • Organizes files by pillar and subsection, sorts alphabetically within each section, and counts files per subsection.
  • Updates CONTENT_PATHS.md with full repository-root paths, per-pillar counts, a grand total, and a last updated timestamp.

Quick Start

Run the update-paths command to refresh CONTENT_PATHS.md for all WAF pillar docs. Use --dry-run to preview changes without applying updates, and --verify to ensure the inventory is current.

Frequently Asked Questions about update-paths

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

FAQPage Schema
How do I automate documentation inventory for MDX files in a repository?

Automating documentation inventory for MDX files involves scanning pillar directories to track new, moved, or deleted files and compile them into a manifest. This process targets .mdx files under specific repository paths while excluding template locations.

What is the best way to keep a documentation file index updated automatically?

Keeping a documentation file index updated requires scanning directories for .mdx files, sorting them alphabetically within subsections, and recording counts and timestamps. This generates a current listing in a manifest file with full repository-root paths.

How do I generate a manifest of MDX files with per-section counts and timestamps?

Generating a manifest of MDX files with per-section counts requires scanning pillar directories, organizing files by subsection, and sorting them alphabetically. The output records per-pillar counts, a grand total, and the last updated timestamp in a markdown file.

Can I preview documentation inventory changes before applying them to the manifest?

Previewing documentation inventory changes before applying them is possible using a dry-run command. This allows you to verify the updated listing of .mdx files without modifying the actual manifest file.

Does the documentation inventory process exclude template files?

The documentation inventory process does exclude template files. It specifically targets .mdx files in pillar directories while ignoring any files located within template directories to maintain an accurate documentation manifest.