adding-documentation-pages_skill

Overview

This skill creates documentation pages for guides, tutorials, knowledge-base articles, and troubleshooting content under docs/. It standardizes frontmatter, file naming, image handling, links, and sidebar updates so new pages render correctly in the docs site. Use it to add content to get-started/, applications/, databases/, knowledge-base/, troubleshoot/, or integrations/.

How this skill works

The skill guides you to create a markdown file in the correct docs/ section, add required frontmatter (title and description), and write structured content with clear headings. It enforces image rules (small images vs. screenshots using <ZoomableImage>), requires absolute internal links and UTM-tagged external links, and reminds you to update the site sidebar configuration so the page appears in navigation. Finally, it verifies rendering locally at the dev server URL.

When to use it

• Adding how-to guides to docs/knowledge-base/ or docs/get-started/
• Writing tutorials or step-by-step walkthroughs for applications or integrations
• Creating troubleshooting articles for docs/troubleshoot/
• Adding database deployment guides under docs/databases/
• Adding integration instructions to docs/integrations/

Best practices

• Add frontmatter with title and SEO-friendly description at the top of every page
• Use lowercase kebab-case file names (e.g., my-guide.md) that are concise and descriptive
• Use <ZoomableImage> for screenshots and large images; prefer .webp and absolute /docs/images/ paths
• Use absolute internal links and append ?utm_source=coolify.io to external links
• Update docs/.vitepress/config.mts sidebar entries so the page is discoverable in navigation
• Run the local dev server and confirm the page renders at the expected path before merging

Example use cases

• Create a get-started guide: docs/get-started/installation.md with setup steps and screenshots
• Add an application framework guide under docs/applications/express-deploy.md that shows deployment commands and config
• Write a knowledge-base article describing a common configuration pattern and link to related pages
• Publish a troubleshooting article that lists symptoms, root causes, and step-by-step fixes in docs/troubleshoot/
• Document a third-party integration with API keys, permissions, and example requests under docs/integrations/