Skip to content

feat(skills): add docs authoring and maintenance skills#11975

Open
jd wants to merge 1 commit into
mainfrom
devs/jd/worktree-skill/add-docs-authoring-maintenance-skills--e17e7c54
Open

feat(skills): add docs authoring and maintenance skills#11975
jd wants to merge 1 commit into
mainfrom
devs/jd/worktree-skill/add-docs-authoring-maintenance-skills--e17e7c54

Conversation

@jd

@jd jd commented Jun 29, 2026

Copy link
Copy Markdown
Member

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

Copilot AI review requested due to automatic review settings June 29, 2026 16:49
@mergify mergify Bot had a problem deploying to Mergify Merge Protections June 29, 2026 16:49 Failure
@mergify

mergify Bot commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Merge Protections

🟢 All 6 merge protections satisfied — ready to merge.

Show 6 satisfied protections

🟢 🤖 Continuous Integration

  • all of:
    • check-success = build
    • check-success = lint
    • check-success = test
    • any of:
      • check-success = test-broken-links
      • label = ignore-broken-links
    • any of:
      • check-success=Cloudflare Pages
      • -head-repo-full-name~=^Mergifyio/

🟢 👀 Review Requirements

  • any of:
    • #approved-reviews-by >= 2
    • author = dependabot[bot]
    • author = mergify-ci-bot

🟢 Enforce conventional commit

Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/

  • title ~= ^(fix|feat|docs|style|refactor|perf|test|build|ci|chore|revert|ui)(?:\(.+\))?:

🟢 🔎 Reviews

  • #changes-requested-reviews-by = 0
  • #review-requested = 0
  • #review-threads-unresolved = 0

🟢 📕 PR description

  • body ~= (?ms:.{48,})

🟢 🚦 Auto-queue

When all merge protections are satisfied, this pull request will be queued automatically.

@mergify mergify Bot requested a review from a team June 29, 2026 16:52

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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, and validate-config-examples skills 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.

Comment thread .claude/skills/validate-config-examples/SKILL.md Outdated
Comment thread .claude/skills/validate-config-examples/SKILL.md Outdated
Comment thread .claude/skills/validate-config-examples/SKILL.md Outdated
Comment thread .claude/skills/capture-screenshots/SKILL.md
Comment thread .claude/skills/docs-gap-analysis/references/signal-sources.md Outdated
Comment thread .claude/skills/validate-config-examples/scripts/extract_yaml.py Outdated
Comment thread .claude/skills/capture-screenshots/SKILL.md
Comment thread .claude/skills/capture-screenshots/SKILL.md
Comment thread .claude/skills/capture-screenshots/SKILL.md
Comment thread .claude/skills/capture-screenshots/SKILL.md
@jd jd force-pushed the devs/jd/worktree-skill/add-docs-authoring-maintenance-skills--e17e7c54 branch from b506881 to b30cb9a Compare June 30, 2026 15:20
@jd

jd commented Jun 30, 2026

Copy link
Copy Markdown
Member Author

This pull request is part of a Mergify stack:

# Pull Request Link
1 feat(skills): add docs authoring and maintenance skills #11975 👈
2 docs: close gaps found by docs-gap-analysis #11996

@jd

jd commented Jun 30, 2026

Copy link
Copy Markdown
Member Author

Revision history

# Type Changes Reason Date
1 initial b506881 2026-06-30 15:20 UTC
2 content b506881 → b30cb9a (raw) 2026-06-30 15:20 UTC
3 content b30cb9a → c8189f5 (raw) address Copilot review: make mergify config validate the primary validator with --config-file (skill optional), make Linear MCP optional with a UI fallback, note capture-screenshots targets the claud… 2026-06-30 15:44 UTC

@mergify mergify Bot had a problem deploying to Mergify Merge Protections June 30, 2026 15:21 Failure
@jd jd marked this pull request as ready for review June 30, 2026 15:38
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
@jd jd force-pushed the devs/jd/worktree-skill/add-docs-authoring-maintenance-skills--e17e7c54 branch from b30cb9a to c8189f5 Compare June 30, 2026 15:44
@mergify mergify Bot deployed to Mergify Merge Protections June 30, 2026 15:45 Active
@mergify mergify Bot requested a review from a team June 30, 2026 20:22
@mergify

mergify Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Merge Queue Status

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Development

Successfully merging this pull request may close these issues.

4 participants