podverse-documentation-conventions

Official

Consistent doc naming across the Podverse monorepo

Authorpodverse
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Documentation at Podverse often suffers from inconsistent file naming, ambiguity about which files belong to which docs, and difficulty locating the correct Markdown docs across the monorepo. This skill defines a set of naming conventions that enforce unique, full-path-based file names to reduce confusion and improve discoverability.

Core Features & Use Cases

  • Enforces one documentation file per directory by naming files after their full path (e.g., APPS-API.md for apps/api).
  • Ensures consistent, predictable navigation and search results across root docs and directory-specific docs.
  • Supports migration and onboarding tasks by providing a clear, scalable naming scheme for new documentation.

Quick Start

Follow the directory-wide naming conventions when creating or renaming documentation files.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: podverse-documentation-conventions
Download link: https://github.com/podverse/podverse/archive/main.zip#podverse-documentation-conventions

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.