overview-from-index

Generate a Docusaurus category overview page from index.mdx and child docs.

1|Updated Apr 17, 2025
One-click install
npx skills add https://github.com/vendasta/partnercenter-docs --skill overview-from-index
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: overview-from-index
Source: https://github.com/vendasta/partnercenter-docs/tree/main/.cursor/skills/overview-from-index
Command: npx skills add https://github.com/vendasta/partnercenter-docs --skill overview-from-index

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Converts category index pages into a cohesive overview/landing page by reading the index and its child docs, then embedding concise context and navigation.

Core Features & Use Cases

  • Auto-generates an overview from the category index and its children, preserving links and context for quick navigation.
  • Maintains the index as the single source of truth, enriching it with a concise intro, what's included, and getting started guidance.
  • Useful when converting existing index.mdx into a fuller landing page to improve discoverability of docs categories.

Quick Start

Update the category index to include a concise overview and a 'what's included' list so the page functions as a full landing page.

Frequently Asked Questions about overview-from-index

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

FAQPage Schema
How do I convert a Docusaurus category index into a landing page?

You can convert a Docusaurus category index into a landing page by enriching the index.mdx file with an auto-generated overview, a list of included child docs, and a getting started section for quick navigation.

What is the best way to generate an overview from a Docusaurus index and its child docs?

Generating an overview from a Docusaurus index involves reading the index file and its child docs to derive an opening. This process maintains the index as the single source of truth while adding context and navigation.

Can I use an existing index.mdx file as a full landing page for a docs category?

Yes, you can use an existing index.mdx file as a full landing page. The Skill expands the index by deriving an opening, listing child docs, and embedding getting started guidance directly into the file.

Does converting a Docusaurus category index require manually writing the overview content?

Converting a Docusaurus category index does not require manually writing the overview content. The Skill auto-generates the overview by reading the index and its children, preserving links and context for quick navigation.

Why use a category index as the single source of truth for a Docusaurus overview page?

Using a category index as the single source of truth for a Docusaurus overview page ensures that the derived intro, included child docs, and getting started guidance remain synchronized with the actual documentation structure.