janpeter/Scrum4Me
0
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 10

docs(naming): drop scrum4me- prefix from doc filenames

Browse source
This commit is contained in:
Janpeter Visser 2026-05-03 00:32:32 +02:00
parent 6c49a5013d
commit f5ff3673e2
35 changed files with 198 additions and 193 deletions
Download patch file Download diff file Expand all files Collapse all files

40
docs/plans/docs-restructure-pbi-spec.md
View file

@ -1,6 +1,6 @@
---
spec_version: 1
spec_type: scrum4me-pbi-bulk-create
spec_type: pbi-bulk-create
generated_at: 2026-05-02
language: en
notes: |
@ -45,12 +45,12 @@ no index, no machine-readable status. After this PBI, the agent reads
`AGENTS.md`) carries YAML front-matter with at minimum
`title`, `status`, `audience`, `language`, `last_updated`. Add
`related`, `when_to_read`, `do_not_read_for` where useful.
- **Naming:** lowercase kebab-case. No `scrum4me-` prefix. No spaces in
- **Naming:** lowercase kebab-case. No `` prefix. No spaces in
filenames. No UPPER. Files matching `_*.md` are personal sidecar and
excluded from the index.
- **Commits:** one commit per logical layer. Use `docs(<story-slug>):`
as the prefix when no ST-code applies. Reference the matching story
slug from this spec (e.g. `docs(naming): drop scrum4me- prefix`).
slug from this spec (e.g. `docs(naming): drop prefix`).
- **Pushing:** never push without explicit user approval. Local commits
on the feature branch only. The branch convention is
`feat/docs-restructure-<phase-slug>` (one branch per story).
@ -135,7 +135,7 @@ pbi:
- English for new/touched docs (UI strings stay Dutch).
- YAML front-matter on every doc (title, status, audience, language,
last_updated; related/when_to_read/do_not_read_for where useful).
- kebab-case, lowercase, no scrum4me- prefix, no spaces.
- kebab-case, lowercase, no prefix, no spaces.
- One commit per logical layer (`docs(<story-slug>):` prefix).
- No pushes without user approval.
- Update every internal link in the same commit as a rename.
@ -250,11 +250,11 @@ pbi:
- slug: naming-normalization
title: "Phase 2 — Normalize file naming"
description: |
Drop the `scrum4me-` prefix. Lowercase everything. Remove the
Drop the `` prefix. Lowercase everything. Remove the
space + em-dash filename. Rename Next.js 16 middleware to proxy.
After this story all filenames are kebab-case and grep-friendly.
acceptance_criteria: |
- No file under docs/ starts with `scrum4me-`.
- No file under docs/ starts with ``.
- No file under docs/ uses UPPER, snake_case, or contains spaces.
- docs/patterns/middleware.md is renamed to docs/patterns/proxy.md.
- Every internal link to renamed files is updated in the same
@ -263,24 +263,24 @@ pbi:
priority: 2
tasks:
- title: "Rename docs/scrum4me-* (drop prefix)"
- title: "Rename docs/* (drop prefix)"
description: "8 spec/backlog/styling files at docs/ root."
implementation_plan: |
git mv docs/scrum4me-architecture.md docs/architecture.md
git mv docs/scrum4me-backlog.md docs/backlog.md
git mv docs/scrum4me-functional-spec.md docs/functional.md
git mv docs/scrum4me-pbi-dialog.md docs/pbi-dialog.md
git mv docs/scrum4me-personas.md docs/personas.md
git mv docs/scrum4me-product-backlog.md docs/product-backlog.md
git mv docs/scrum4me-story-dialog.md docs/story-dialog.md
git mv docs/scrum4me-styling.md docs/styling.md
git mv docs/scrum4me-task-dialog.md docs/task-dialog.md
git mv docs/scrum4me-test-plan.md docs/test-plan.md
git mv docs/architecture.md docs/architecture.md
git mv docs/backlog.md docs/backlog.md
git mv docs/functional-spec.md docs/functional.md
git mv docs/pbi-dialog.md docs/pbi-dialog.md
git mv docs/personas.md docs/personas.md
git mv docs/product-backlog.md docs/product-backlog.md
git mv docs/story-dialog.md docs/story-dialog.md
git mv docs/styling.md docs/styling.md
git mv docs/task-dialog.md docs/task-dialog.md
git mv docs/test-plan.md docs/test-plan.md
# update every internal link
grep -rln "scrum4me-" docs/ CLAUDE.md AGENTS.md README.md \
| xargs sed -i '' 's|scrum4me-||g'
grep -rln "" docs/ CLAUDE.md AGENTS.md README.md \
| xargs sed -i '' 's|||g'
npm run docs:index
commit: docs(naming): drop scrum4me- prefix from doc filenames
commit: docs(naming): drop prefix from doc filenames
priority: 2
- title: "Lowercase API.md and MD3 file"