From 16f56fd961b60b5ccd1d9ffb026892236c182ef7 Mon Sep 17 00:00:00 2001 From: sjat Date: Mon, 18 May 2026 17:07:26 +0200 Subject: [PATCH] docs: standardise filenames to ASCII kebab-case + ISO date prefix MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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) --- CLAUDE.md | 18 ++++++++++++------ ...akerFLOSS_house_rules.md => house-rules.md} | 0 docs/index.md | 2 +- .../labdesign.md | 0 .../vps-and-dns.md} | 0 ...11_messaging.md => 2026-05-11-messaging.md} | 0 ....md => 2026-05-11-social-media-taxonomy.md} | 0 mkdocs.yml | 2 +- ...bookpost.md => 2026-03-16-facebook-post.md} | 0 .../{2026-04-14_todo.md => 2026-04-14-todo.md} | 0 notes/todo/{OM_services.md => om-services.md} | 0 notes/todo/{indkøbsliste.md => wishlist.md} | 0 12 files changed, 14 insertions(+), 8 deletions(-) rename docs/{makerFLOSS_house_rules.md => house-rules.md} (100%) rename docs/{infrastruktur => infrastructure}/labdesign.md (100%) rename docs/{infrastruktur/vps-og-dns.md => infrastructure/vps-and-dns.md} (100%) rename docs/presentations/{2026-05-11_messaging.md => 2026-05-11-messaging.md} (100%) rename docs/presentations/{2026-05-11_SoMe-taxonomi.md => 2026-05-11-social-media-taxonomy.md} (100%) rename notes/communications/{2026-03-16_facebookpost.md => 2026-03-16-facebook-post.md} (100%) rename notes/todo/{2026-04-14_todo.md => 2026-04-14-todo.md} (100%) rename notes/todo/{OM_services.md => om-services.md} (100%) rename notes/todo/{indkøbsliste.md => wishlist.md} (100%) diff --git a/CLAUDE.md b/CLAUDE.md index 2ff6031..884fcf7 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -8,7 +8,7 @@ This is a **documentation-only repository** for the MakerFLOSS initiative at Ora ## 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) - **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 - **Decisions**: Lightweight markdown decision logs - **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 ``` -docs/ - infrastruktur/ # Infrastructure documentation (VPS, DNS, etc.) - kommunikation/ # Communication materials (Facebook posts, announcements) - møder/ # Meeting notes - todo/ # Task lists and working norms +docs/ # everything here is built and shipped to docs.makerfloss.eu + hardware/ # auto-indexed per-host frontmatter (mf00..mf03, makerfloss.eu) + infrastructure/ # labdesign, VPS/DNS, etc. + presentations/ # Marp decks (build-slides.sh) +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 diff --git a/docs/makerFLOSS_house_rules.md b/docs/house-rules.md similarity index 100% rename from docs/makerFLOSS_house_rules.md rename to docs/house-rules.md diff --git a/docs/index.md b/docs/index.md index 9a99788..9213d6f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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 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. ## Working norms (summary) diff --git a/docs/infrastruktur/labdesign.md b/docs/infrastructure/labdesign.md similarity index 100% rename from docs/infrastruktur/labdesign.md rename to docs/infrastructure/labdesign.md diff --git a/docs/infrastruktur/vps-og-dns.md b/docs/infrastructure/vps-and-dns.md similarity index 100% rename from docs/infrastruktur/vps-og-dns.md rename to docs/infrastructure/vps-and-dns.md diff --git a/docs/presentations/2026-05-11_messaging.md b/docs/presentations/2026-05-11-messaging.md similarity index 100% rename from docs/presentations/2026-05-11_messaging.md rename to docs/presentations/2026-05-11-messaging.md diff --git a/docs/presentations/2026-05-11_SoMe-taxonomi.md b/docs/presentations/2026-05-11-social-media-taxonomy.md similarity index 100% rename from docs/presentations/2026-05-11_SoMe-taxonomi.md rename to docs/presentations/2026-05-11-social-media-taxonomy.md diff --git a/mkdocs.yml b/mkdocs.yml index 16e9767..b89c0a6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -55,4 +55,4 @@ nav: - Home: index.md - Hardware: - hardware/index.md - - House rules: makerFLOSS_house_rules.md + - House rules: house-rules.md diff --git a/notes/communications/2026-03-16_facebookpost.md b/notes/communications/2026-03-16-facebook-post.md similarity index 100% rename from notes/communications/2026-03-16_facebookpost.md rename to notes/communications/2026-03-16-facebook-post.md diff --git a/notes/todo/2026-04-14_todo.md b/notes/todo/2026-04-14-todo.md similarity index 100% rename from notes/todo/2026-04-14_todo.md rename to notes/todo/2026-04-14-todo.md diff --git a/notes/todo/OM_services.md b/notes/todo/om-services.md similarity index 100% rename from notes/todo/OM_services.md rename to notes/todo/om-services.md diff --git a/notes/todo/indkøbsliste.md b/notes/todo/wishlist.md similarity index 100% rename from notes/todo/indkøbsliste.md rename to notes/todo/wishlist.md