ce-rtd-writer

Name: ce-rtd-writer
Availability: InStock
Author: moffran

Create and maintain ReadTheDocs pages with CE-first structure and toctree integration.

78|15|Updated May 1, 2023

Search Tags:#templates #documentation #writer #toctree #ce-first #rtd

Ready to run

npx skills add https://github.com/Moffran/calibrated_explanations --skill ce-rtd-writer

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: ce-rtd-writer
Source: https://github.com/Moffran/calibrated_explanations/tree/main/.claude/skills/ce-rtd-writer
Command: npx skills add https://github.com/Moffran/calibrated_explanations --skill ce-rtd-writer

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes assets (resource) components.

What problem does it solve?

This skill enables you to consistently craft and revise ReadTheDocs pages with audience-aware structure, CE-first examples, and correct toctree integration, reducing boilerplate and ensuring documentation quality.

Core Features & Use Cases

Provides a ready-to-use RTD page template via assets/rtd_page_template.md for new pages.
Guides authors through audience-targeted placement, template-driven page creation, and proper navigation of toctrees.
Use cases include creating new docs pages, updating existing content, and maintaining consistent CE-first documentation workflows.

Quick Start

Copy the rtd page template to docs/<target>/<new-page>.md and begin editing to create a CE-first RTD page.

Frequently Asked Questions about ce-rtd-writer

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

FAQPage Schema

How do I create ReadTheDocs pages with consistent structure and toctree integration?▼

To create ReadTheDocs pages with consistent structure, copy the provided RTD page template to your target docs directory and begin editing. This ensures correct toctree integration and audience-aware content placement for software documentation.

What is a CE-first documentation workflow for software projects?▼

A CE-first documentation workflow prioritizes audience-aware content creation by applying reusable templates and scalable page authoring guidelines. It ensures clear publishing workflows and self-audit checks for maintaining consistent documentation quality across software projects.

Can I use a markdown template for new RTD pages in my existing docs directory?▼

Yes, you can use the markdown template for new RTD pages by copying the included page template asset directly into your target docs folder. This allows you to immediately begin authoring CE-first content within your existing project structure.

What's the best way to maintain documentation quality when updating existing RTD pages?▼

The best way to maintain documentation quality when updating existing RTD pages is to apply audience-aware structure guidelines and self-audit checks. Using a reusable template ensures revisions remain consistent and correctly integrated with your toctree navigation.

Do I need any specific dependencies to start writing CE-first RTD pages?▼

No specific dependencies are required to start writing CE-first RTD pages. The skill provides a ready-to-use markdown template and guidelines that can be applied directly to your software project's documentation workflow without additional environment setup.