skills.rest
hirokazu-kobayashi-koba-hiro
hirokazu-kobayashi-koba-hiroCOMMUNITY
Explore all skills by this author →
GitHub

documentation

Document Docusaurus-based idp-server documentation workflows with local previews and OpenAPI references.

7|1|Updated Feb 12, 2023
Search Tags:#documentation#openapi#translation#docusaurus#content-structure#local-preview
One-click install
npx skills add https://github.com/hirokazu-kobayashi-koba-hiro/idp-server --skill documentation-hirokazu-kobayashi-koba-hiro
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/hirokazu-kobayashi-koba-hiro/idp-server/tree/main/.claude/skills/documentation
Command: npx skills add https://github.com/hirokazu-kobayashi-koba-hiro/idp-server --skill documentation-hirokazu-kobayashi-koba-hiro

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation development and governance for idp-server, enabling consistent structure, local previews, and OpenAPI references.

Core Features & Use Cases

  • Docusaurus configuration and multi-language support.
  • Content organization, local preview generation, and alignment with OpenAPI references.
  • Use Case: A maintainer updates API docs and previews changes locally before publishing.

Quick Start

Install dependencies and start the documentation server to preview changes locally.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I preview Docusaurus documentation changes locally before publishing?▼

To preview Docusaurus documentation locally, install the project dependencies and start the local documentation server to render and review content changes before publishing.

What is the best way to synchronize OpenAPI references with Docusaurus content?▼

Synchronizing OpenAPI references with Docusaurus uses a front-matter driven system that aligns API specifications with content structure, ensuring accurate multi-language API documentation.

How do I structure multi-language documentation for a Docusaurus project?▼

Structuring multi-language documentation in Docusaurus involves configuring the built-in internationalization support and applying a consistent front-matter system to organize content across translations.

Does this documentation workflow support front-matter driven content organization?▼

Yes, the documentation workflow conforms to a front-matter driven system that defines content structure, enabling consistent organization and local previews for Docusaurus projects.

Can I use this workflow to maintain API docs for an idp-server project?▼

Yes, this workflow specifically documents the development and governance process for idp-server, enabling consistent structure, local previews, and OpenAPI reference alignment.

Why do I need a front-matter driven system for local preview generation?▼

A front-matter driven system is needed for local preview generation because it defines the content structure that the documentation server renders, ensuring local previews match the final published output.

Related Skills

Explore More Content & Communication Skills→
MakisuoMakisuo
1.6k

clickhousectl-local-dev

Install and configure a local ClickHouse environment with clickhousectl.

Community
Intermediate
92Bilal2692Bilal26

docusaurus-deployer

Automate Docusaurus site deployment to GitHub Pages with GitHub Actions.

Community
Intermediate
masermediagroup-stackmasermediagroup-stack
1

generating-documentation

Automates generation of APIs, code, ADR, and diagram documentation.

Community
Advanced
soo-kate-yeonsoo-kate-yeon

moai-docs-generation

Generate API documentation from source code and OpenAPI specifications.

Community
Advanced