write-doc

Create VitePress documentation pages compliant with aihub-core project guidelines.

9|2|Updated Nov 29, 2024
One-click install
npx skills add https://github.com/bbvch-ai/aihub-core --skill write-doc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: write-doc
Source: https://github.com/bbvch-ai/aihub-core/tree/main/.claude/skills/write-doc
Command: npx skills add https://github.com/bbvch-ai/aihub-core --skill write-doc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill eliminates the tedious, error-prone work of manually writing VitePress documentation pages for the aihub-core project, ensuring all content adheres to the project's strict structural, formatting, and writing guidelines without requiring contributors to memorize complex rules.

Core Features & Use Cases

  • Strict structural enforcement: Automatically guides correct file placement (only index.en.md in numbered topic directories) to ensure pages appear in the correct sidebar position.
  • Formatting and style validation: Provides clear rules for VitePress-specific elements (containers, code blocks, Mermaid diagrams, internal links) and enforces the project's writing guidelines to avoid common errors like incorrect heading casing, grandiose language, and unverified technical claims.
  • Use Case: A contributor documenting a new platform feature can use this Skill to automatically place the page in the correct 2_platform/ subsection, add valid frontmatter, follow the required writing style, and verify all media and link paths before publishing.

Quick Start

Use the write-doc skill to create a new documentation page explaining how to configure LLM provider routing for the platform.

Frequently Asked Questions about write-doc

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

FAQPage Schema
How do I create VitePress documentation pages that enforce strict file structure and frontmatter?

To create VitePress documentation pages with strict file structure, you must place index.en.md in numbered topic directories and apply valid frontmatter. This ensures pages appear in the correct sidebar position and adhere to project content guidelines.

What are the content guidelines for writing technical documentation in open source projects?

Technical documentation content guidelines require avoiding incorrect heading casing, grandiose language, and unverified technical claims. You must follow specific formatting rules for VitePress elements like containers, code blocks, and Mermaid diagrams to reduce manual review overhead.

How do I format VitePress elements like Mermaid diagrams and internal links correctly?

Formatting VitePress elements correctly involves applying project-specific rules for containers, code blocks, Mermaid diagrams, and internal links. You must verify all media and link paths before publishing to ensure compliant VitePress documentation generation.

Does this documentation generation approach work for contributor workflows adding new feature guides?

Documentation generation works for contributor workflows adding new feature guides or reference pages. It automates page placement in correct subsections, adds valid frontmatter, and enforces writing style to satisfy open source project technical writing rules.

Why does my VitePress documentation page appear in the wrong sidebar ordering?

VitePress documentation pages appear in the wrong sidebar ordering when file placement is incorrect. You must place only index.en.md inside numbered topic directories to ensure the page automatically appears in the correct sidebar position.

What is the best way to automate docs generation for VitePress to avoid manual review overhead?

The best way to automate docs generation for VitePress is enforcing strict structural, formatting, and writing guidelines automatically during page creation. This validates media asset referencing and internal linking to eliminate error-prone manual review overhead.