Skip to content

[Skill] doc-update: Auto-refresh operator documentation on source changes #52

Description

@sunway513

Skill

doc-update

Priority: P2 (Medium — prevents documentation staleness)

Motivation

AITER's operator documentation (in docs/) is manually maintained and frequently falls behind source code changes. When a kernel's signature changes, new parameters are added, or dtype support is extended, the corresponding guide becomes stale. This skill detects which documentation is affected by recent source changes and produces targeted updates — fixing API signatures, parameter names, and feature claims without requiring a full doc rewrite.

What This Skill Should Do

  1. Detect affected docs: Given a commit range or PR diff, identify which docs/*_guide.md files reference functions that changed
  2. Extract changes: For each affected function, diff the old vs new signature — identify added/removed/renamed parameters and new dtype support
  3. Update signatures: In the affected guide, update the Quick Reference section and API examples to match the new signature
  4. Update feature claims: If new backends or dtypes are added, update the feature tables and decision trees in the guide
  5. Validate updates: After updating, run the doc-factcheck skill to verify all claims in the updated guide are still accurate

Acceptance Criteria

  • Can detect which docs are affected by a given commit range
  • Correctly identifies parameter name changes, additions, and removals
  • Updates Quick Reference API examples with correct new signatures
  • Updates feature/dtype support tables when backends change
  • Does NOT fabricate features — only documents what actually exists in source
  • Integrates with doc-factcheck skill for post-update validation

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions