vcluster-docs-writer

Automate writing, editing, and quality checks for vCluster Docusaurus documentation.

11|57|Updated Mar 4, 2024
One-click install
npx skills add https://github.com/loft-sh/vcluster-docs --skill vcluster-docs-writer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: vcluster-docs-writer
Source: https://github.com/loft-sh/vcluster-docs/tree/main/.claude/skills/vcluster-docs-writer
Command: npx skills add https://github.com/loft-sh/vcluster-docs --skill vcluster-docs-writer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Write and edit vCluster documentation in a consistent, high-quality way by automating style checks, partials discovery, link validation, and release preparation.

Core Features & Use Cases

  • Vale linting to enforce terminology and style
  • Partial and code discovery to accelerate content reuse
  • Link validation and versioned docs guidance to prevent broken links
  • Release preparation checks to ensure docs readiness

Quick Start

Ask the skill to write or fix vCluster docs in the vcluster-docs repository and follow its Vale linting, partials discovery, and link-validation workflows.

Frequently Asked Questions about vcluster-docs-writer

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

FAQPage Schema
How do I automate documentation linting and style checks for Docusaurus?

Documentation linting and style checks are automated using Vale to enforce terminology and style guidelines. This ensures consistent authoring and quality control across Docusaurus documentation files.

What's the best way to validate Docusaurus links and manage versioned docs?

Link validation and versioned docs management prevent broken links by checking internal references and applying version-specific guidance. This ensures documentation integrity across multiple release versions.

How do I discover partials and reusable code snippets in Docusaurus documentation?

Partials discovery accelerates content reuse by automatically locating reusable code snippets and documentation fragments within the repository. This streamlines the authoring process and reduces duplication.

Do I need the vcluster-docs repository to use this documentation workflow?

Yes, this workflow specifically applies to tasks within the /vcluster-docs repository. It leverages repository scripts and style guidelines to maintain documentation consistency and enforce quality checks.

How do I prepare documentation for a vCluster release?

Release preparation checks ensure documentation readiness by validating links, running Vale linting, and verifying versioned docs before a release. This prevents shipping broken or inconsistent documentation.

Why does Docusaurus documentation build fail with broken links during versioning?

Broken links occur when versioned docs contain outdated references. Link validation identifies these issues, and applying versioned docs guidance ensures references remain correct across different documentation versions.