repo-website-guide-create

Create structured documentation guides for the Formisch website across frameworks.

1.1k|32|Updated Apr 5, 2025
One-click install
npx skills add https://github.com/open-circle/formisch --skill repo-website-guide-create
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: repo-website-guide-create
Source: https://github.com/open-circle/formisch/tree/main/skills/repo-website-guide-create
Command: npx skills add https://github.com/open-circle/formisch --skill repo-website-guide-create

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill provides a standardized approach to adding new documentation guides and tutorials to the Formisch website, reducing manual setup and ensuring consistency across frameworks.

Core Features & Use Cases

  • Guides scaffolding: creates the correct folder structure under website/src/routes/{framework}/guides/ with menu.md and index.mdx patterns.
  • Category and metadata enforcement: ensures guides fall into (get-started), (main-concepts), or (advanced-guides) with required front matter like title and description.
  • Menu integration: updates website/src/routes/{framework}/guides/menu.md to include new guides with proper routing.
  • Documentation patterns: provides MDX content conventions, front matter, and code example templates to accelerate guide creation.

Quick Start

Create a new guide directory using mkdir -p website/src/routes/{framework}/guides/(category)/guide-slug/, add an index.mdx with front matter including title, description, and contributors, and update the corresponding menu in menu.md.

Frequently Asked Questions about repo-website-guide-create

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

FAQPage Schema
How do I create structured documentation guides for the Formisch website?

To create documentation guides for the Formisch website, scaffold the correct directory structure under website/src/routes/{framework}/guides/(category)/guide-slug/ and add an index.mdx file with required front matter including title, description, and contributors. This enforces consistency across framework routes like solid, qwik, preact, svelte, and vue.

What front matter is required for MDX guides in Formisch?

Required front matter for MDX guides includes title, description, and contributors fields. This metadata ensures guides are properly categorized within get-started, main-concepts, or advanced-guides sections and displayed correctly across the Formisch website navigation menu.

How do I update navigation menus when adding new framework guides?

Update navigation menus by modifying the website/src/routes/{framework}/guides/menu.md file to include new guides with proper routing. This ensures newly created documentation appears in the correct navigation structure for each framework route.

Can I use this guide scaffolding across multiple frontend frameworks?

Yes, guide scaffolding supports multiple frontend framework routes including solid, qwik, preact, svelte, and vue. Each framework maintains its own directory structure and menu.md file for organizing get-started, main-concepts, and advanced-guides categories.

What directory structure does Formisch expect for advanced guides?

Formisch expects advanced guides in the directory structure website/src/routes/{framework}/guides/(advanced-guides)/guide-slug/. This structure categorizes content properly and ensures the guide integrates with existing menu navigation and MDX content conventions.

What are the limitations of automating Formisch website guide creation?

Automation is limited to the Formisch website structure and supports only get-started, main-concepts, and advanced-guides categories across solid, qwik, preact, svelte, and vue routes. Guides must follow MDX content conventions and required front matter patterns to function correctly within the navigation menu.