contributor-docs-nav

Regenerate breadcrumbs and TOCs for CONTRIBUTOR-DOCS and verify internal links.

1.5k|257|Updated Nov 19, 2018

Search Tags:#automation #documentation #navigation #breadcrumbs #contributor-guides #toc-generation #link-verification

Ready to run

npx skills add https://github.com/adobe/spectrum-web-components --skill contributor-docs-nav

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: contributor-docs-nav
Source: https://github.com/adobe/spectrum-web-components/tree/main/.ai/skills/contributor-docs-nav
Command: npx skills add https://github.com/adobe/spectrum-web-components --skill contributor-docs-nav

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill updates site navigation by regenerating breadcrumbs and TOCs for CONTRIBUTOR-DOCS and verifying internal links to prevent broken navigation.

Core Features & Use Cases

Regenerates breadcrumbs and in-doc TOCs for CONTRIBUTOR-DOCS
Verifies and reports broken links, enabling quick fixes
Supports updates after file moves, renames, or heading changes to keep navigation accurate

Quick Start

Execute the navigation script to refresh breadcrumbs, update TOCs, and validate all links in CONTRIBUTOR-DOCS.

Frequently Asked Questions about contributor-docs-nav

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

FAQPage Schema

How do I regenerate contributor docs navigation after moving files?▼

To regenerate contributor docs navigation after moving files, execute the navigation script to refresh breadcrumbs, update in-document TOCs, and verify all internal links to prevent broken navigation.

How do I fix broken internal links in contributor guides?▼

To fix broken internal links in contributor guides, run the link verification process to detect invalid references, which then reports the broken links back with actionable fixes to correct the navigation.

When do I need to update breadcrumbs and TOCs for documentation?▼

You need to update breadcrumbs and TOCs for documentation whenever the contributor docs structure changes, such as when files are added, removed, renamed, moved, or when document headings are altered.

Does link verification handle file renames and heading changes automatically?▼

Link verification handles common scenarios after file renames and heading changes by enforcing script safety during execution and reporting results back with actionable fixes for broken navigation.

What is the best way to prevent broken navigation in contributor docs?▼

The best way to prevent broken navigation in contributor docs is to run an automated navigation script that regenerates breadcrumbs, updates TOCs, and validates internal links after any structural changes.

Are there limitations when verifying links after altering document headings?▼

When verifying links after altering document headings, the process handles common link-verification scenarios and reports actionable fixes, though it is specifically scoped to internal links within the CONTRIBUTOR-DOCS structure.