AD

adding-service-documentation

Automates the documentation process for Coolify services using frontmatter-driven generation.

Install

mkdir -p .claude/skills/adding-service-documentation && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/3662" && unzip -o skill.zip -d .claude/skills/adding-service-documentation && rm skill.zip

Installs to .claude/skills/adding-service-documentation

Activation

This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.

Documents new Coolify one-click services by creating markdown pages in docs/services/, downloading logos to docs/public/images/services/, and regenerating the services listing. Use when adding service documentation, creating service pages, onboarding services from templates/compose/, or refreshing the services catalog.
320 chars✓ has a “when” triggerlonger than Claude Code's old 250-char listing cap (fine on current versions)
Beginner

Key capabilities

  • →Generate service documentation pages
  • →Manage service logo assets
  • →Regenerate service catalog listings
  • →Validate frontmatter metadata

How it works

The skill uses scripts to parse markdown frontmatter and automatically resolve logo paths. It regenerates the service listing and catalog data based on the provided markdown files.

Inputs & outputs

You give it
Service metadata and logo file
You get back
Updated service documentation and catalog

When to use adding-service-documentation

  • →Documenting a new one-click service
  • →Creating service catalog pages
  • →Updating service icons
  • →Regenerating service listings

About this skill

Add Service Documentation

Create service pages in the current Fumadocs content tree. Read CLAUDE.md for repository commands and conventions.

Content Pipeline

Source or outputPurpose
content/docs/services/{slug}.mdxAuthored service page; the filename determines the slug
public/images/services/Local service logos and screenshots
src/generated/services.jsonGenerated catalog data consumed by src/components/data/services-list.tsx
content/docs/services/all.mdxGenerated categorized directory

Both generators use scripts/services-data.mjs. It reads the top-level .mdx files in content/docs/services/, resolves local icons, and derives availability from frontmatter and recognized warning titles. It excludes all.mdx, index.mdx, overview.mdx, how-services-work.mdx, and what-is-a-service.mdx.

Do not hand-edit either generated output. Run bun run generate:services. Generation also runs before bun run dev, bun run build, and bun run types:check. bun run preview serves the existing build without regenerating content.

Workflow

  1. Check the relevant Coolify revision's templates/compose/ YAML for the service, deployment variants, metadata, and availability. Skip new catalog entries marked # ignore: true; use disabling-services when updating an existing unavailable service.
  2. Download the upstream logo to public/images/services/{slug}-logo.svg (or its actual image extension). See METADATA.md and IMAGES.md.
  3. Create content/docs/services/{slug}.mdx, starting from templates/service.mdx or TEMPLATES.md. Replace template placeholders and add the required catalog frontmatter.
  4. Write the service description, verified setup details, and official links. Follow DOCUMENTATION.md.
  5. Run bun run generate:services. Check that the slug appears in src/generated/services.json and, for an enabled service, in content/docs/services/all.mdx under the right category.
  6. Verify the page at http://localhost:3000/docs/services/{slug} and its card in /docs/services/overview. When committing, include the authored page, any new assets, and both generated outputs.

Individual service pages are discovered by the catalog generator. Do not add every service to content/docs/services/meta.json; that file organizes the section's guides and catalog entry points.

Service Frontmatter

---
title: "Service Name"
description: "Short description for the service card and directory."
category: "Analytics"
icon: "/docs/images/services/service-name-logo.svg"
---

Use an existing category where possible. icon is optional when the logo resolver finds a matching local file. Set disabled: true to hide a service from both catalogs while keeping its page reachable. See CATALOG.md for resolution order and availability rules.

The collector reads only top-level scalar fields. Nested og metadata is not used for the service card; see FRONTMATTER.md for the current SEO behavior.

Related References

  • IMAGES.md: public asset paths and supported image components.
  • LINKS.md: internal routes and external links.
  • CONTAINERS.md: MDX callouts and other registered components.
  • TESTING.md: isolated generator checks and page verification.

Troubleshooting

  • Missing service: confirm the file is content/docs/services/{slug}.mdx, has frontmatter, and is not one of the excluded filenames. Check disabled and recognized warning titles before regenerating.
  • Missing icon: check the actual file under public/images/services/, use a resolver-friendly filename, or set icon to an existing /docs/images/services/... URL. The generator warns about invalid icons.
  • Wrong grouping: category is used verbatim. Inspect current categories in the generated JSON rather than creating a near-duplicate spelling.

When not to use it

  • →Hand-editing generated catalog files
  • →Linking to external image URLs

Prerequisites

Bun

Limitations

  • →Cannot hand-edit generated files
  • →Requires specific file naming conventions for auto-resolution

How it compares

This workflow automates the catalog generation process, preventing manual errors and ensuring consistency across the documentation site.

Compared to similar skills

adding-service-documentation side by side with the closest alternatives in the catalog.

SkillInstallsUpdatedSafetyDifficulty
adding-service-documentation (this skill)16moReviewBeginner
ml-paper-writing489moReviewAdvanced
docs-review1011moNo flagsBeginner
claude-md-improver2110moReviewBeginner

Try saying

Example prompts that trigger this skill in your AI assistant.

You might also like

ml-paper-writing

davila7

Write publication-ready ML/AI papers for NeurIPS, ICML, ICLR, ACL, AAAI, COLM. Use when drafting papers from research repos, structuring arguments, verifying citations, or preparing camera-ready submissions. Includes LaTeX templates, reviewer guidelines, and citation verification workflows.

4897

docs-review

metabase

Review documentation changes for compliance with the Metabase writing style guide. Use when reviewing pull requests, files, or diffs containing documentation markdown files.

1085

claude-md-improver

anthropics

Audit and improve CLAUDE.md files in repositories. Use when user asks to check, audit, update, improve, or fix CLAUDE.md files. Scans for all CLAUDE.md files, evaluates quality against templates, outputs quality report, then makes targeted updates. Also use when the user mentions "CLAUDE.md maintenance" or "project memory optimization".

2167

write-docs

tldraw

Writing SDK documentation for tldraw. Use when creating new documentation articles, updating existing docs, or when documentation writing guidance is needed. Applies to docs in apps/docs/content/.

665

update-docs

vercel

This skill should be used when the user asks to "update documentation for my changes", "check docs for this PR", "what docs need updating", "sync docs with code", "scaffold docs for this feature", "document this feature", "review docs completeness", "add docs for this change", "what documentation is affected", "docs impact", or mentions "docs/", "docs/01-app", "docs/02-pages", "MDX", "documentation update", "API reference", ".mdx files". Provides guided workflow for updating Next.js documentation based on code changes.

2543

wiki-architect

microsoft

Analyzes code repositories and generates hierarchical documentation structures with onboarding guides. Use when the user wants to create a wiki, generate documentation, map a codebase structure, or understand a project's architecture at a high level.

1144

Search skills

Search the agent skills registry