renaming-services

Name: renaming-services
Availability: InStock
Author: coolLabs

Rename service documentation files and update references across Services List and nginx redirects.

369|323|Updated Sep 4, 2024

Search Tags:#git #documentation #links #rename #nginx #redirects

Ready to run

npx skills add https://github.com/coollabsio/coolify-docs --skill renaming-services

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: renaming-services
Source: https://github.com/coollabsio/coolify-docs/tree/main/.claude/skills/renaming-services
Command: npx skills add https://github.com/coollabsio/coolify-docs --skill renaming-services

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

When a service name changes, its documentation can become inconsistent or lead to broken links. This Skill ensures renaming a service's documentation is performed across all required locations, preserving navigation integrity.

Core Features & Use Cases

Cross-file renaming: Rename the documentation file to the new slug and align it with the service name.
Synchronized updates: Update the Services List (docs/.vitepress/theme/components/Services/List.vue) and nginx redirects (nginx/redirects.conf) to reflect the new slug.
Link integrity maintenance: Audit and fix internal references to the old slug to prevent 404s after the rename.

Quick Start

Rename the documentation file: git mv docs/services/old-name.md docs/services/new-name.md
Update the Services List slug in docs/.vitepress/theme/components/Services/List.vue to match new-name.
Add 301 redirects in nginx/redirects.conf from /docs/services/old-name to /docs/services/new-name.
Search for and update any remaining references to old-name across the documentation base.

Frequently Asked Questions about renaming-services

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

FAQPage Schema

How do I rename a service doc and keep navigation links from breaking?▼

To rename service documentation without broken links, you must rename the markdown file, update the Services List entry, add nginx 301 redirects, and fix remaining internal references to the old slug.

What steps are required to update nginx redirects when changing a service slug?▼

Updating nginx redirects requires adding 301 rules in nginx/redirects.conf mapping the old service path to the new slug, ensuring visitors hitting the old documentation URL are seamlessly forwarded.

When do I need to add 301 redirects for documentation files?▼

You need 301 redirects for documentation files whenever a service slug or name changes, preventing 404 errors for existing internal references and external links pointing to the old documentation path.

How do I check for remaining internal references to an old service slug?▼

Checking for remaining internal references involves searching the entire documentation base for the old slug name after renaming the file and updating the Services List, ensuring no broken links remain.

Can I use git mv to rename documentation files without breaking the Services List?▼

Using git mv to rename documentation files works, but you must also update the slug in the Services List component and add nginx redirects to maintain navigation integrity and prevent broken links.

What is the best way to prevent 404s after renaming a service?▼

The best way to prevent 404s after renaming a service is to add 301 redirects in nginx/redirects.conf from the old documentation path to the new slug, while auditing and fixing all internal references.