feat(skills): add docs authoring and maintenance skills#11975
Conversation
Merge Protections🟢 All 6 merge protections satisfied — ready to merge. Show 6 satisfied protections🟢 🤖 Continuous Integration
🟢 👀 Review Requirements
🟢 Enforce conventional commitMake sure that we follow https://www.conventionalcommits.org/en/v1.0.0/
🟢 🔎 Reviews
🟢 📕 PR description
🟢 🚦 Auto-queueWhen all merge protections are satisfied, this pull request will be queued automatically. |
There was a problem hiding this comment.
Pull request overview
Adds four Claude Code “skills” that form a docs authoring/maintenance workflow for this repository (feature documentation orchestration, screenshot capture, config-example validation, and docs gap analysis), plus supporting reference docs and a YAML-fence extraction script.
Changes:
- Introduces
document-a-feature,docs-gap-analysis,capture-screenshots, andvalidate-config-examplesskills under.claude/skills/. - Adds reference guides (placement/plumbing, component selection, signal sources, screenshot conventions).
- Adds a Python helper to extract/classify YAML fences from MDX for config-example validation.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 11 comments.
Show a summary per file
| File | Description |
|---|---|
| .claude/skills/validate-config-examples/SKILL.md | Defines the workflow for extracting YAML fences and validating real .mergify.yml examples. |
| .claude/skills/validate-config-examples/scripts/extract_yaml.py | Stdlib script to find YAML/yml fences in MDX and classify them for validation vs skipping. |
| .claude/skills/document-a-feature/SKILL.md | Orchestrator checklist for writing/wiring a docs page and running validations. |
| .claude/skills/document-a-feature/references/placement-guide.md | Placement + navItems/_redirects/SEO wiring guide for new/moved docs pages. |
| .claude/skills/document-a-feature/references/component-decision-table.md | Maps content types to preferred Astro/React components for docs pages. |
| .claude/skills/docs-gap-analysis/SKILL.md | Process for identifying doc gaps by comparing shipped product signal to docs coverage. |
| .claude/skills/docs-gap-analysis/references/signal-sources.md | Concrete sources and query patterns (PRs/Linear/changelog) for shipped-feature signal. |
| .claude/skills/capture-screenshots/SKILL.md | Workflow for capturing dashboard screenshots and emitting ready-to-paste astro:assets snippet. |
| .claude/skills/capture-screenshots/references/conventions.md | Screenshot standards: viewport, theme, naming, overlay removal, common URLs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
b506881 to
b30cb9a
Compare
|
This pull request is part of a Mergify stack:
|
Revision history
|
Add four project skills that compose into one docs workflow: - document-a-feature: end-to-end orchestrator (placement, component selection, writing, navItems/_redirects/SEO plumbing, proofread + config validation + build check) - capture-screenshots: Chrome MCP dashboard screenshots with consistent viewport, correct images/ path, and ready-to-paste astro:assets snippet - validate-config-examples: extract and classify YAML fences, validate real Mergify configs via `mergify config validate` - docs-gap-analysis: diff shipped product (PRs/Linear/changelog) against docs to surface undocumented/partial/stale features docs-gap-analysis finds the work, document-a-feature does it and calls the other two as tools; all reuse the existing mdx-documentation and proofread-* skills rather than duplicating them. No changelog skill by design (changelog entries are autogenerated and must not be touched). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Change-Id: Ie17e7c5434df6122f99d1904ae9eeaf6e71f2211
b30cb9a to
c8189f5
Compare
Merge Queue Status
|
Add four project skills that compose into one docs workflow:
selection, writing, navItems/_redirects/SEO plumbing, proofread +
config validation + build check)
viewport, correct images/ path, and ready-to-paste astro:assets snippet
real Mergify configs via
mergify config validatedocs to surface undocumented/partial/stale features
docs-gap-analysis finds the work, document-a-feature does it and calls the
other two as tools; all reuse the existing mdx-documentation and proofread-*
skills rather than duplicating them. No changelog skill by design (changelog
entries are autogenerated and must not be touched).
Co-Authored-By: Claude Opus 4.8 (1M context) noreply@anthropic.com