write-guides

Write, rewrite, and audit Remix guide chapters in Markdown documentation.

33.3k|2.8k|Updated Oct 26, 2020
One-click install
npx skills add https://github.com/remix-run/remix --skill write-guides
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: write-guides
Source: https://github.com/remix-run/remix/tree/main/.agents/skills/write-guides
Command: npx skills add https://github.com/remix-run/remix --skill write-guides

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Guide chapters often drift into generic, AI-sounding prose with abstract claims, repeated takeaways, and inconsistent code examples. This Skill enforces the concrete, conversational voice of the Remix docs so chapters read like a person walking through real code.

Core Features & Use Cases

  • Voice Matching: Aligns chapters with the style of 01-start-here.md, using concrete files, routes, handlers, and responses instead of abstract framing.
  • AI-Prose Auditing: Identifies generated-sounding patterns (generic transitions, placeholder nouns, overconfident claims) with line numbers and rewrite directions.
  • Example Consistency: Keeps code snippets internally consistent with correct imports, remix/... paths, routes.<name>.href(...) usage, and the local chapter formatter config.
  • Anchor Preservation: Protects heading anchors linked from other chapters and validates cross-chapter /docs/... links.
  • Use Case: When revising a chapter under docs/guides/app/actions/docs/chapters/, run the audit workflow to flag AI-sounding prose, then rewrite sections while preserving anchors and running Prettier on the result.

Quick Start

Ask the assistant to audit the guide chapter at docs/guides/app/actions/docs/chapters/02-routing.md for AI-sounding prose and report findings with line numbers.

Frequently Asked Questions about write-guides

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

FAQPage Schema
How do I rewrite a Remix guide chapter to match the docs voice?

Read 01-start-here.md first for voice, then read the target chapter fully. Replace abstract framing with concrete files, routes, and responses, remove repeated takeaways, and re-read the chapter next to 01-start-here.md to smooth voice mismatches.

How to detect AI-sounding prose in Markdown documentation?

Run the audit workflow: read the file with line numbers, group findings by pattern such as generic transitions or placeholder nouns, quote the triggering phrases, and suggest rewrite directions without editing unless asked.

What code style should Remix guide examples follow?

Import from remix/... rather than @remix-run/..., use TypeScript extensions in relative imports, use routes.<name>.href(...) for links and redirects, and return explicit Web Response objects from actions. Let the chapter's .oxfmtrc.json formatter handle snippet style.

Can I change heading anchors in Remix guide chapters?

Only after checking for incoming links with rg "#anchor-name" guides packages. Preserve anchors that other chapters link to, and remove explicit anchors that merely repeat the generated heading anchor.

When should a guide link to API overview docs?

Link when the guide intentionally skips exhaustive syntax, options, or package surface area. Teach just enough API for the reader to follow the guide, show one strong advanced example, and avoid duplicating reference material.