Skip to content

chore: Add agent skills for working with docs#561

Open
Swiftaxe wants to merge 1 commit into
mainfrom
docs/agent-skills
Open

chore: Add agent skills for working with docs#561
Swiftaxe wants to merge 1 commit into
mainfrom
docs/agent-skills

Conversation

@Swiftaxe
Copy link
Copy Markdown
Collaborator

This PR introduces tooling to help maintainers, contributors, and LLM agents write and review documentation consistently.

The goal is to improve:

  • Efficiency
  • Quality
  • Consistency

New file: docs.instructions.md

A code review skill file (auto-applied to docs/, versioned_docs/, cloud_docs/**).

It defines:

  • 16 named noise patterns with bad/good examples drawn from real PR review comments
  • Core writing principles and guidelines
  • Review guidelines
  • Structure rules
  • Helpers for when creating new pages.

Four page templates

Page skeletons for when creating new pages:

  • Concept
  • Guide
  • Tutorial
  • Reference

Test results

Tested using Cursor to review 7 files in the tree. Some screenshot from the review results:

image image

@Swiftaxe Swiftaxe requested review from Zfinix and developerjamiu May 29, 2026 13:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant