Skip to content

Conversation

Cinzya
Copy link
Member

@Cinzya Cinzya commented Sep 14, 2025

Summary

  • Adds comprehensive documentation workflow for contributors who want to add service documentation to the docs repository
  • Provides step-by-step instructions for creating service documentation pages
  • Includes template and formatting guidelines for consistency across service docs

Changes Made

  • New section: "Adding a new service template to the Coolify Documentation" with 5-step process
  • Documentation template: Standard format for service pages with frontmatter, ZoomableImage usage, and content structure
  • Services overview instructions: How to add services to the main Services list component
  • Minor fix: Corrected "Docker Compose" to "Docker Compose Empty" deployment option

Why This Matters

Currently, the contribution guide only covers adding service templates to the main Coolify repository. This addition helps contributors understand the complete process of documenting their services in the docs repository, ensuring users have proper documentation for newly added services.

Test Plan

  • Documentation renders correctly in local development (bun run dev)
  • All formatting and markdown syntax is valid
  • Instructions follow the established pattern of numbered steps with clear actions

🤖 Generated with Claude Code

- Add step-by-step guide for creating service documentation pages
- Include instructions for adding services to the Services overview
- Document required frontmatter format and file structure
- Add template for consistent service documentation format
- Fix typo: "Docker Compose" → "Docker Compose Empty" deployment option

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@Cinzya Cinzya added the ⭐️ New Content Adding entirely new content or guides. label Sep 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
⭐️ New Content Adding entirely new content or guides.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants