docs: standardise filenames to ASCII kebab-case + ISO date prefix
Adopt one filename convention everywhere except hardware host pages
(those are pinned to their hostnames by the index validator):
- ASCII lowercase
- kebab-case word separator
- dated docs: YYYY-MM-DD-label.md (hyphen between date and label)
- English regardless of content language
Renames:
docs/makerFLOSS_house_rules.md -> docs/house-rules.md
docs/infrastruktur/ -> docs/infrastructure/
docs/infrastructure/vps-og-dns.md -> docs/infrastructure/vps-and-dns.md
docs/presentations/2026-05-11_messaging.md -> docs/presentations/2026-05-11-messaging.md
docs/presentations/2026-05-11_SoMe-taxonomi.md -> docs/presentations/2026-05-11-social-media-taxonomy.md
notes/todo/2026-04-14_todo.md -> notes/todo/2026-04-14-todo.md
notes/todo/OM_services.md -> notes/todo/om-services.md
notes/todo/indkøbsliste.md -> notes/todo/wishlist.md
notes/communications/2026-03-16_facebookpost.md -> notes/communications/2026-03-16-facebook-post.md
Other touches:
- Document the convention in CLAUDE.md under Working Norms.
- Refresh the stale Repository Structure block in CLAUDE.md to reflect
the docs/ vs notes/ split introduced in f6d589e.
- Update the House rules link in docs/index.md and the nav entry in
mkdocs.yml to the new house-rules.md path.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
parent
f6d589edec
commit
16f56fd961
12 changed files with 14 additions and 8 deletions
18
CLAUDE.md
18
CLAUDE.md
|
|
@ -8,7 +8,7 @@ This is a **documentation-only repository** for the MakerFLOSS initiative at Ora
|
||||||
|
|
||||||
## Working Norms
|
## Working Norms
|
||||||
|
|
||||||
From `notes/todo/2026-04-14_todo.md`:
|
From `notes/todo/2026-04-14-todo.md`:
|
||||||
|
|
||||||
- **Language**: English for code, docs, commits (meeting notes may be in Danish)
|
- **Language**: English for code, docs, commits (meeting notes may be in Danish)
|
||||||
- **Git**: Trunk-based development, feature branches, simple commit messages
|
- **Git**: Trunk-based development, feature branches, simple commit messages
|
||||||
|
|
@ -17,15 +17,21 @@ From `notes/todo/2026-04-14_todo.md`:
|
||||||
- **AI**: Allowed but reviewed; no secrets in commits
|
- **AI**: Allowed but reviewed; no secrets in commits
|
||||||
- **Decisions**: Lightweight markdown decision logs
|
- **Decisions**: Lightweight markdown decision logs
|
||||||
- **License**: FLOSS by default
|
- **License**: FLOSS by default
|
||||||
|
- **Filenames**: ASCII lowercase, kebab-case (`like-this.md`), English regardless of content language. Dated docs use an ISO prefix joined with a hyphen: `YYYY-MM-DD-label.md`. Hostnames are the exception — `docs/hardware/*.md` must equal the host's `hostname` (enforced by `scripts/gen_overview.py`).
|
||||||
|
|
||||||
## Repository Structure
|
## Repository Structure
|
||||||
|
|
||||||
```
|
```
|
||||||
docs/
|
docs/ # everything here is built and shipped to docs.makerfloss.eu
|
||||||
infrastruktur/ # Infrastructure documentation (VPS, DNS, etc.)
|
hardware/ # auto-indexed per-host frontmatter (mf00..mf03, makerfloss.eu)
|
||||||
kommunikation/ # Communication materials (Facebook posts, announcements)
|
infrastructure/ # labdesign, VPS/DNS, etc.
|
||||||
møder/ # Meeting notes
|
presentations/ # Marp decks (build-slides.sh)
|
||||||
todo/ # Task lists and working norms
|
notes/ # repo-only working material, not built
|
||||||
|
meetings/ # meeting notes (Danish allowed)
|
||||||
|
todo/ # task lists, working norms, wishlist, services
|
||||||
|
dev/ # internal plans/ and specs/
|
||||||
|
communications/ # community comms artifacts (Facebook posts, etc.)
|
||||||
|
sandbox/ # scratch / pipeline fixtures (e.g. test-mermaid.md)
|
||||||
```
|
```
|
||||||
|
|
||||||
## Infrastructure
|
## Infrastructure
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ jam-session community focused on self-hosted, open-source infrastructure.
|
||||||
|
|
||||||
- [Hardware](hardware/index.md) — every machine in the lab, auto-indexed from per-host
|
- [Hardware](hardware/index.md) — every machine in the lab, auto-indexed from per-host
|
||||||
frontmatter blocks. Use this when planning where to deploy a new service.
|
frontmatter blocks. Use this when planning where to deploy a new service.
|
||||||
- [House rules](makerFLOSS_house_rules.md) — working norms, governance, and
|
- [House rules](house-rules.md) — working norms, governance, and
|
||||||
what we do (and don't) do.
|
what we do (and don't) do.
|
||||||
|
|
||||||
## Working norms (summary)
|
## Working norms (summary)
|
||||||
|
|
|
||||||
|
|
@ -55,4 +55,4 @@ nav:
|
||||||
- Home: index.md
|
- Home: index.md
|
||||||
- Hardware:
|
- Hardware:
|
||||||
- hardware/index.md
|
- hardware/index.md
|
||||||
- House rules: makerFLOSS_house_rules.md
|
- House rules: house-rules.md
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue