Exécutez n'importe quel Skill dans Manus
en un clic

Exécutez n'importe quel Skill dans Manus en un clic

Commencer

boilerplate-documentation-conventions

Étoiles0

Forks0

Mis à jour19 mars 2026 à 05:42

Documentation file naming for the Boilerplate repo. Use when creating or modifying docs, README, or markdown.

Installation

Installer avec Codex ou Claude Copiez ce prompt, collez-le dans Codex, Claude ou un autre assistant, puis laissez-le vérifier la page du skill et l'installer pour vous.

Exécuter dans Manus

Source

podverse

podverse/boilerplate

Ouvrir le dépôt GitHub Voir les dépôts du créateur

Téléchargement

Exécuter dans Manus

Métiers associésSOC

Basé sur la classification professionnelle SOC

Rédacteurs techniquesArts, design, divertissement, sports et médias·SOC 27-3042

SKILL.md

readonly

name	boilerplate-documentation-conventions
description	Documentation file naming for the Boilerplate repo. Use when creating or modifying docs, README, or markdown.
version	1.1.0

Documentation Conventions

Single README

One README.md at repository root.
Only one file in the entire repository may be named README (the root README.md). Subdirectories must use descriptive names (e.g. scripts/github/SCRIPTS-GITHUB.md, not README.md).

Directory-Specific Docs

Name after the full path from root (uppercase, slashes → hyphens):

apps/api/ → APPS-API.md
apps/web/ → APPS-WEB.md
infra/k8s/ → INFRA-K8S.md
packages/ui/ → PACKAGES-UI.md
scripts/github/ → SCRIPTS-GITHUB.md
.llm/ → LLM.md

Pattern: [FULL-PATH-WITH-HYPHENS].md. Do not add multiple README.md files per directory.

INDEX.md and plan indexes

The only INDEX.md in the repo is .cursor/skills/INDEX.md (skills quick reference). All other directory overviews use the full-path name (e.g. INFRA-K8S.md, PACKAGES-UI.md).
Plan-set indexes under .llm/plans/ use 00-overview.md or 00-master-plan.md, not INDEX.md or README.md.

Plus depuis ce dépôt

même dépôt

api-testing

podverse/boilerplate

When changing API routes, auth, or env-dependent behavior, add or update the corresponding integration tests and keep the test file layout consistent.

2026-04-070

argocd-gitops-push

podverse/boilerplate

When adding or changing files under infra/k8s/ or sync targets for k8s, know what Argo CD syncs and remind the user to push to Git so the cluster can sync.

2026-04-070

generate-data-sync

podverse/boilerplate

Keeps tools/generate-data seeders and docs in sync when main or management DB schema or ORM entities change. Use when adding or changing tables/entities in packages/orm, packages/management-orm, or infra database migrations.

2026-04-070

roles-schema-sync

podverse/boilerplate

When changing DB schema or permission dimensions, consider predefined roles and bucket_role / role-related code.

2026-04-070

classification-env

podverse/boilerplate

Use when adding or changing environment variables, infra/env/classification YAML, scripts/env-classification, K8s env render, or local env generation.

2026-03-300

boilerplate-api-patterns

podverse/boilerplate

Common patterns for the Boilerplate HTTP API (Express)

2026-03-260

name	boilerplate-documentation-conventions
description	Documentation file naming for the Boilerplate repo. Use when creating or modifying docs, README, or markdown.
version	1.1.0

Documentation Conventions

Single README

One README.md at repository root.
Only one file in the entire repository may be named README (the root README.md). Subdirectories must use descriptive names (e.g. scripts/github/SCRIPTS-GITHUB.md, not README.md).

Directory-Specific Docs

Name after the full path from root (uppercase, slashes → hyphens):

apps/api/ → APPS-API.md
apps/web/ → APPS-WEB.md
infra/k8s/ → INFRA-K8S.md
packages/ui/ → PACKAGES-UI.md
scripts/github/ → SCRIPTS-GITHUB.md
.llm/ → LLM.md

Pattern: [FULL-PATH-WITH-HYPHENS].md. Do not add multiple README.md files per directory.

INDEX.md and plan indexes

The only INDEX.md in the repo is .cursor/skills/INDEX.md (skills quick reference). All other directory overviews use the full-path name (e.g. INFRA-K8S.md, PACKAGES-UI.md).
Plan-set indexes under .llm/plans/ use 00-overview.md or 00-master-plan.md, not INDEX.md or README.md.