oat-docs-authoring

Author and restructure documentation pages in OAT/Fumadocs apps.

Updated May 9, 2020
One-click install
npx skills add https://github.com/tkstang/sequence --skill oat-docs-authoring
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: oat-docs-authoring
Source: https://github.com/tkstang/sequence/tree/main/.agents/skills/oat-docs-authoring
Command: npx skills add https://github.com/tkstang/sequence --skill oat-docs-authoring

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill addresses the challenges of authoring and restructuring targeted content within existing OAT/Fumadocs documentation apps, ensuring compatibility and quality while preserving navigation and validation.

Core Features & Use Cases

  • Targeted Authoring: Create or improve targeted documentation pages within an existing app.
  • Mode Assertion: Defines strict boundaries for allowed activities, such as not bootstrapping new apps or running broad audits.
  • Progress Indicators: Provides feedback on each step of the authoring process.
  • Reference Map: Loads only the necessary references for the task, optimizing performance.
  • Use Case: When you need to add a new page to an OAT/Fumadocs app and ensure it fits within the existing structure and navigation.

Quick Start

Use the oat-docs-authoring skill to add a new page to the 'Reference' section of your OAT/Fumadocs app.

Frequently Asked Questions about oat-docs-authoring

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

FAQPage Schema
How do I add a new page to an existing OAT/Fumadocs app without breaking navigation?

To add a new page to an OAT/Fumadocs app without breaking navigation, use targeted documentation authoring to preserve generated indexes and validation boundaries while fitting the new content within the existing structure.

What is the best way to restructure OAT/Fumadocs documentation?

Restructuring OAT/Fumadocs documentation involves moving or renaming existing pages while strictly adhering to OAT/Fumadocs conventions, using local validation scripts to repair navigation issues and ensure compatibility.

Can I use this to bootstrap a new Fumadocs application?

No, you cannot use this to bootstrap a new Fumadocs application. Mode assertion defines strict boundaries that prevent bootstrapping new apps or running broad audits, focusing solely on targeted authoring within existing projects.

How does the documentation authoring process handle validation?

The documentation authoring process handles validation by using local scripts to enforce validation boundaries. A reference map loads only necessary references for the task, optimizing performance and providing progress indicators for each step.

Why does moving a page in my OAT documentation break the local navigation?

Moving a page breaks local navigation when OAT/Fumadocs conventions are not preserved. You must repair local navigation issues by adhering to validation boundaries and using local scripts for artifact generation during restructuring.