docs-doc-group

Create bilingual index.mdx landing pages for child-bearing documentation groups.

12|2|Updated Nov 27, 2024
One-click install
npx skills add https://github.com/Pionpill/retikz --skill docs-doc-group
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-doc-group
Source: https://github.com/Pionpill/retikz/tree/main/.agents/skills/docs-doc-group
Command: npx skills add https://github.com/Pionpill/retikz --skill docs-doc-group

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill solves the inconsistency and duplication that happen when writing documentation for grouped concepts, especially when groups have children and need a clear navigation hub.

Core Features & Use Cases

  • Creates group landing pages for child-based group nodes with index.{zh,en}.mdx at the group directory root.
  • Ensures correct structure and intent: an onboarding-style introduction plus a responsibilities table plus a LinkedCard index, without copying full APIs from child overview pages.
  • Supports two group types with the right table model: component families (Sugar/Kernel) and reference families (topic-based).
  • Enforces documentation consistency by following the shared principle and using the correct figure component.

Quick Start

Write a new contents/<module>/.../<group>/index.zh.mdx file following the Skill’s required sections and tables for the selected group type (components vs reference).

Frequently Asked Questions about docs-doc-group

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

FAQPage Schema
How do I create bilingual documentation landing pages for grouped component families?

To create bilingual documentation landing pages for grouped component families, you write index.{zh,en}.mdx files at the group directory root following a mandated structure with an onboarding introduction, responsibilities table, and LinkedCard child index.

What is the best way to structure a navigation hub for component families without duplicating child APIs?

The best way to structure a navigation hub without duplicating child APIs is to use a LinkedCard-based child indexing system paired with a responsibilities table, ensuring the group landing page serves as a navigation hub rather than repeating child overview content.

How do I write MDX documentation for reference families versus component families?

Writing MDX documentation for reference families versus component families requires selecting the correct group type to apply the appropriate responsibilities table model, ensuring the onboarding-style introduction and child index match the specific family category.

Does this documentation structure approach work for React and DX doc sites?

Yes, this documentation structure approach works for React and DX doc sites that need family-view navigation hubs for component families like Sugar or Kernel and reference families without repeating child APIs.

Can I add narrative figures to the group documentation landing pages?

Yes, you can add narrative figures to the group documentation landing pages by optionally using the docs-figure-draw component alongside the required introduction, responsibilities table, and LinkedCard index sections.

Why do my grouped documentation pages have inconsistent structures and duplicated content?

Grouped documentation pages have inconsistent structures and duplicated content because they lack a mandated SKILL.md-defined structure enforcing standardized onboarding sections, responsibilities tables, and LinkedCard child indexing across family groups.