docs-writing

Define documentation-writing conventions for Tako website MDX pages.

160|8|Updated Jun 15, 2025
One-click install
npx skills add https://github.com/rust-dd/tako --skill docs-writing-rust-dd
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-writing
Source: https://github.com/rust-dd/tako/tree/main/.claude/skills/docs-writing
Command: npx skills add https://github.com/rust-dd/tako --skill docs-writing-rust-dd

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Establishes a consistent, reusable standard for authoring Tako documentation across website/content/docs, ensuring clarity and uniform structure.

Core Features & Use Cases

  • Defines the per-page authoring contract, frontmatter schema, and templates for transports, extractors, middleware, plugins, concepts, tutorials, guides, and reference pages.
  • Specifies the audit-script contract, meta.json wiring, and usage of RustExample-backed examples to keep docs accurate and runnable.
  • Provides guidance on when to invoke these conventions (e.g., for new public types or when fixing rot in existing pages).

Quick Start

Create a new docs page using the per-page authoring contract and wire it into the appropriate meta.json.

Frequently Asked Questions about docs-writing

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

FAQPage Schema
How do I write MDX documentation for Tako website content?

MDX documentation for Tako website content requires a defined frontmatter schema, per-page templates for specific page types, and meta.json wiring to ensure consistent structure and accurate auditing.

What frontmatter schema is required for Tako docs pages?

The required frontmatter schema for Tako docs pages is specified by the per-page authoring contract, which validates metadata fields across templates like transports, extractors, middleware, plugins, concepts, tutorials, guides, and reference pages.

When should I use the Tako docs-writing conventions?

Invoke the Tako docs-writing conventions when authoring new public types, adding per-page MDX documents, or fixing documentation rot in existing pages to maintain uniform structure and accuracy.

How do I wire a new documentation page into the Tako website?

To wire a new documentation page into the Tako website, create the MDX document using the per-page authoring contract and register it within the appropriate meta.json file.

Does the Tako documentation standard support runnable Rust examples?

Yes, the Tako documentation standard supports runnable Rust examples using RustExample-backed components, which are validated by the audit-script contract to keep documentation accurate and executable.

What documentation templates are available for Tako components?

Available documentation templates for Tako components include specific per-page authoring contracts for transports, extractors, middleware, plugins, concepts, tutorials, guides, and reference pages.