Skip to main content

contributor-docs-nav

Run the CONTRIBUTOR-DOCS nav script to update breadcrumbs and TOCs, and handle link verification. Use when updating contributor docs structure, regenerating navigation, or fixing broken links.

소스 정보

저장소
adobe/spectrum-web-components
최근 소스 활동
2026년 4월 21일 23:45
감지된 SKILL.md 언어
영어
스타
1,576
포크
274

설치 방법

기본적으로 소스를 먼저 확인하는 Prompt가 선택됩니다. 직접 명령으로 전환하거나 로컬 사본을 다운로드할 수도 있습니다.

소스 파일 검토

설치 여부를 결정하기 전에 SKILL.md와 SkillsMP에 표시된 보조 파일을 읽어 보세요.

파일 탐색기
2 개 파일

SKILL.md 표시 중

SKILL.md
소스 지침 · 읽기 전용 미리보기
name
contributor-docs-nav
description
Run the CONTRIBUTOR-DOCS nav script to update breadcrumbs and TOCs, and handle link verification. Use when updating contributor docs structure, regenerating navigation, or fixing broken links.
# Contributor docs navigation Run the regeneration script to update breadcrumbs and TOCs in CONTRIBUTOR-DOCS, and handle link verification. Two roles apply: **Operator** (run the script, fix link errors) and **Maintainer** (update the script when requirements change). ## Mindset You are a documentation maintainer. Broken links and stale navigation are bugs, not inconveniences. Never mark work done until every link is verified. ## When to use this skill - A file or folder under CONTRIBUTOR-DOCS is added, removed, renamed, or moved - Document H1, H2, or H3 headings are changed - The user asks to update contributor docs navigation, regenerate TOC, or fix broken links in CONTRIBUTOR-DOCS - The contributor-doc-update rule is triggered (editing CONTRIBUTOR-DOCS structure) ## How to invoke - Say "update contributor docs nav", "regenerate TOC", "fix broken links in CONTRIBUTOR-DOCS", or "run the nav script" - Or add, remove, rename, or move files under `CONTRIBUTOR-DOCS/` or change H1/H2/H3 headings — the agent should run the nav script and may use this skill ## Quick reference ### Operator: run the script 1. **When to run**: File/folder add/remove/rename/move; heading changes; folder structure changes; or user request. 2. **How to run** (from project root): ```bash cd CONTRIBUTOR-DOCS/01_contributor-guides/07_authoring-contributor-docs node update-nav.js ``` 3. **After running**: Verify success, report results (files updated, link counts). Fix straightforward link errors automatically; ask the user when the fix is ambiguous (e.g. target file removed, multiple anchor matches). ### Maintainer: update the script - **When**: Naming/convention changes, breadcrumb/TOC format changes, new edge cases, or display-name rule changes. - **Process**: Review change → update `update-nav.js` → test on full tree → update docs and report. ## Full instructions For complete Operator and Maintainer workflows, debugging, link-verification handling, script behavior details, and the testing checklist, read: **.ai/skills/contributor-docs-nav/references/ai-agent-instructions.md** That document is the single source of truth for when to run, how to run, responsibilities, debugging, handling link verification errors, maintainer process, script architecture, and testing checklist.
GitHub에서 보기