skills.rest
coollabsio
coollabsioOFFICIAL
Explore all skills by this author →
Website𝕏@coolifyioGitHub

adding-documentation-pages

Create and organize documentation pages within Coolify docs.

369|323|Updated Sep 4, 2024
Search Tags:#templates#documentation#markdown#docs#frontmatter#sidebar#knowledge-base
One-click install
npx skills add https://github.com/coollabsio/coolify-docs --skill adding-documentation-pages
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: adding-documentation-pages
Source: https://github.com/coollabsio/coolify-docs/tree/main/.claude/skills/adding-documentation-pages
Command: npx skills add https://github.com/coollabsio/coolify-docs --skill adding-documentation-pages

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill simplifies creating and organizing documentation pages within the Coolify docs, ensuring consistent structure and easier upkeep.

Core Features & Use Cases

  • Create new documentation pages in sections like Get Started, Applications, Databases, Knowledge Base, Troubleshoot, and Integrations.
  • Update the doc site navigation by adjusting the sidebar in docs/.vitepress/config.mts.
  • Enforce frontmatter requirements (title and description) for each page and promote consistent templates and images.

Quick Start

Create a Markdown file in the appropriate docs directory. Add frontmatter with title and description. Write content with clear headings and sections. Update the sidebar if needed. Add images using the ZoomableImage component.

Frequently Asked Questions about adding-documentation-pages

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

FAQPage Schema
How do I add new documentation pages to Coolify docs?▼

Adding documentation pages requires creating a Markdown file with frontmatter containing a title and description, writing content with clear headings, and updating the sidebar configuration in docs/.vitepress/config.mts to include the new page.

What frontmatter is required for Coolify knowledge base articles?▼

Coolify knowledge base articles require frontmatter with a title and description to enforce consistent structure and ensure proper metadata across all documentation pages.

How do I update the sidebar navigation for VitePress docs?▼

Update the VitePress sidebar by modifying the docs/.vitepress/config.mts file to register new Markdown pages, ensuring they appear correctly in the site navigation.

Can I use templates for different types of docs like troubleshooting and tutorials?▼

Templates are supported for guides, tutorials, troubleshooting, and knowledge base articles, promoting consistent content structure and simplifying ongoing documentation upkeep.

What is the best way to add images to Coolify documentation pages?▼

The best way to add images to Coolify documentation pages is by using the ZoomableImage component within your Markdown files to ensure proper image rendering and display behavior.

Related Skills

Explore More Content & Communication Skills→
p-iknowp-iknow
1

doc-frontmatter

Generate and validate YAML frontmatter for Markdown documentation files.

Community
Intermediate
xiaolaixiaolai
6

fw-vitepress

Parse VitePress config and sidebar navigation to map source code to documentation templates.

Community
Intermediate
heamlkheamlk

vitepress

Generate static documentation sites from Markdown using VitePress.

Community
Intermediate
pleaseaipleaseai
12

vitepress

Renders Markdown into static documentation sites with Vue-powered theming.

Official
Intermediate