editor

Automate review and proofreading of Astro MDX documentation with structure and STE checks.

4|2|Updated Jun 11, 2024
One-click install
npx skills add https://github.com/adaptyteam/adapty-docs --skill editor-adaptyteam
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: editor
Source: https://github.com/adaptyteam/adapty-docs/tree/main/.claude/skills/editor
Command: npx skills add https://github.com/adaptyteam/adapty-docs --skill editor-adaptyteam

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill automates the review and proofreading of Astro-based technical documentation, ensuring clarity, precision, and consistency across MDX content.

Core Features & Use Cases

  • Structured editorial review: Validate heading hierarchy, tone, and writing style for MDX articles in src/content/docs.
  • Quality checks: Verify Simplified Technical English compliance, correct links and images, and adherence to technical writing best practices.
  • Actionable improvements: Provide concrete rewrite suggestions and load relevant references to support fixes.
  • Trigger-based workflows: Responds to requests to review changes in feature branches or specific documentation articles.

Quick Start

Review the MDX file(s) in your docs repository (e.g., src/content/docs/your-article.mdx) and request targeted edits focusing on clarity, structure, and STE compliance.

Frequently Asked Questions about editor

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate proofreading for MDX articles in an Astro docs project?

You can automate proofreading for MDX articles in an Astro docs project by applying a structured editorial review that validates heading hierarchy, tone, and writing style. This process checks files in src/content/docs to ensure clarity, precision, and consistency.

What is Simplified Technical English compliance for technical documentation?

Simplified Technical English (STE) compliance for technical documentation restricts vocabulary and sentence structure to improve clarity and consistency. It enforces concise, precise writing while delivering actionable rewrite suggestions for MDX content.

Can I review documentation changes in feature branches without external tools?

Yes, you can review documentation changes in feature branches without external tools. The review process applies directly to diffs in feature branches, performing structure checks, clarity polishing, STE compliance, and link/image validation.

Does the MDX review process validate links and images?

Yes, the MDX review process validates links and images. It verifies correct links and images alongside Simplified Technical English compliance and adherence to technical writing best practices.

How do I get actionable rewrite suggestions for technical writing?

You get actionable rewrite suggestions for technical writing by triggering an editorial review on your MDX articles. This provides concrete rewrite suggestions and loads relevant references to support fixes.