write-docs

Generate and refine tldraw SDK documentation under apps/docs/content/.

Updated Jul 15, 2023

Search Tags:#documentation #markdown #SDK #frontmatter #API references #tldraw

Ready to run

npx skills add https://github.com/algusaem/algusaem-portfolio --skill write-docs-algusaem

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: write-docs
Source: https://github.com/algusaem/algusaem-portfolio/tree/main/.claude/skills/write-docs
Command: npx skills add https://github.com/algusaem/algusaem-portfolio --skill write-docs-algusaem

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps creators generate and refine SDK documentation for tldraw, ensuring consistency, clarity, and alignment with established writing guidelines.

Core Features & Use Cases

Documentation generation: Create new articles and update existing docs under apps/docs/content/ with a consistent structure.
Guidance and style enforcement: Apply frontmatter rules, Markdown conventions, and code-first writing patterns to API references and tutorials.
Use Case: When adding a new Editor API reference, the Skill formats the article, inserts standard sections, and ensures proper metadata.

Quick Start

Create a new article at apps/docs/content/editor-api-createShapes.md with frontmatter and a short usage example.

Frequently Asked Questions about write-docs

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

FAQPage Schema

How do I generate tldraw SDK documentation for API references?▼

To generate tldraw SDK documentation, create new articles under apps/docs/content/ with proper frontmatter, markdown structure, and code-first usage examples. The skill enforces concise writing standards for API references and tutorials automatically.

What is the best way to structure markdown for tldraw SDK tutorials?▼

The best way to structure markdown for tldraw SDK tutorials is by applying standard frontmatter rules and a code-first writing pattern. This ensures clarity and alignment with established documentation guidelines for usage notes.

Does tldraw documentation require specific frontmatter and markdown conventions?▼

Yes, tldraw documentation requires specific frontmatter and markdown conventions to maintain consistency across SDK articles. The skill enforces these structural rules automatically when creating or updating content.

How do I update existing tldraw SDK docs under apps/docs/content/?▼

You can update existing tldraw SDK docs by refining articles located in apps/docs/content/ to meet formatting guidelines. The skill automates inserting standard sections, metadata, and concise code examples during updates.

Can I use standard markdown formatting for tldraw Editor API references?▼

Yes, you can use standard markdown formatting for tldraw Editor API references, provided it includes the required frontmatter. The skill formats the article and ensures proper metadata and short usage examples are inserted.