From 72886f47844f7fd0a83167077a46f2aecc75707b Mon Sep 17 00:00:00 2001 From: fs Date: Fri, 6 Mar 2026 12:25:18 +0100 Subject: [PATCH] docs: restructure docs to diataxis and finalize DOCS-RESTRUCTURE-001 --- .../execution-report.json | 121 +++++++++++++ .../runs/DOCS-RESTRUCTURE-001/finalize.json | 10 ++ .../runs/DOCS-RESTRUCTURE-001/plan.json | 167 ++++++++++++++++++ .../review-acceptance.json | 65 +++++++ .../DOCS-RESTRUCTURE-001/review-guards.json | 16 ++ ...hitektur.md => explanation-architektur.md} | 10 +- ...ntainer.md => explanation-di-container.md} | 2 + ...trieb.md => explanation-docker-betrieb.md} | 6 +- ... explanation-einstellungen-speicherung.md} | 2 +- ...ll.md => explanation-sicherheitsmodell.md} | 8 +- ...nfragelimits.md => howto-anfragelimits.md} | 2 +- ...e-test.md => howto-auth-sso-smoke-test.md} | 2 +- ....md => howto-benutzerdefinierte-felder.md} | 2 +- ...octor.md => howto-betriebscheck-doctor.md} | 2 +- ...{docker-lokal.md => howto-docker-lokal.md} | 2 +- ...produktiv.md => howto-docker-produktiv.md} | 2 +- ...rn.md => howto-dokumentation-erweitern.md} | 24 +-- ...-aenderung.md => howto-erste-aenderung.md} | 4 +- ...lerbehebung.md => howto-fehlerbehebung.md} | 2 +- ...aufgaben.md => howto-geplante-aufgaben.md} | 2 +- ...lobale-suche.md => howto-globale-suche.md} | 2 +- docs/{importe.md => howto-importe.md} | 2 +- ...icklung.md => howto-lokale-entwicklung.md} | 6 +- ....md => howto-rbac-permissions-playbook.md} | 2 +- ...n.md => howto-request-input-validation.md} | 2 +- docs/index.md | 153 ++++++++-------- .../flow.md => reference-agents-flow.md} | 2 + ...erview.md => reference-agents-overview.md} | 2 + .../roles.md => reference-agents-roles.md} | 2 + docs/{api.md => reference-api.md} | 8 +- ...=> reference-benutzer-lifecycle-policy.md} | 2 +- ...-prompts.md => reference-codex-prompts.md} | 2 +- ...glossar.md => reference-domain-glossar.md} | 6 +- ....md => reference-entwickler-checkliste.md} | 14 +- ...ntend-css.md => reference-frontend-css.md} | 2 +- ...pt.md => reference-frontend-javascript.md} | 2 +- ...guration.md => reference-konfiguration.md} | 2 +- ...ventionen.md => reference-konventionen.md} | 2 +- ...tandards.md => reference-lib-standards.md} | 8 +- ...ritte.md => tutorial-01-erste-schritte.md} | 12 +- ...ick.md => tutorial-02-systemueberblick.md} | 8 +- ... => tutorial-03-setup-und-erster-login.md} | 6 +- ...> tutorial-04-architektur-request-flow.md} | 8 +- ...i.md => tutorial-05-erste-aenderung-ui.md} | 6 +- ...=> tutorial-06-erste-aenderung-backend.md} | 6 +- ...d => tutorial-07-security-tenant-scope.md} | 6 +- ...eitern.md => tutorial-08-api-erweitern.md} | 6 +- ... => tutorial-09-advanced-scheduler-sso.md} | 10 +- .../Architecture/CodexSkillsContractTest.php | 4 +- 49 files changed, 564 insertions(+), 180 deletions(-) create mode 100644 agent-system/runs/DOCS-RESTRUCTURE-001/execution-report.json create mode 100644 agent-system/runs/DOCS-RESTRUCTURE-001/finalize.json create mode 100644 agent-system/runs/DOCS-RESTRUCTURE-001/plan.json create mode 100644 agent-system/runs/DOCS-RESTRUCTURE-001/review-acceptance.json create mode 100644 agent-system/runs/DOCS-RESTRUCTURE-001/review-guards.json rename docs/{architektur.md => explanation-architektur.md} (96%) rename docs/{di-container.md => explanation-di-container.md} (99%) rename docs/{docker-betrieb.md => explanation-docker-betrieb.md} (81%) rename docs/{einstellungen-speicherung.md => explanation-einstellungen-speicherung.md} (98%) rename docs/{sicherheitsmodell.md => explanation-sicherheitsmodell.md} (96%) rename docs/{anfragelimits.md => howto-anfragelimits.md} (97%) rename docs/{auth-sso-smoke-test.md => howto-auth-sso-smoke-test.md} (98%) rename docs/{benutzerdefinierte-felder.md => howto-benutzerdefinierte-felder.md} (98%) rename docs/{betriebscheck-doctor.md => howto-betriebscheck-doctor.md} (97%) rename docs/{docker-lokal.md => howto-docker-lokal.md} (97%) rename docs/{docker-produktiv.md => howto-docker-produktiv.md} (98%) rename docs/{dokumentation-erweitern.md => howto-dokumentation-erweitern.md} (56%) rename docs/{erste-aenderung.md => howto-erste-aenderung.md} (96%) rename docs/{fehlerbehebung.md => howto-fehlerbehebung.md} (98%) rename docs/{geplante-aufgaben.md => howto-geplante-aufgaben.md} (98%) rename docs/{globale-suche.md => howto-globale-suche.md} (98%) rename docs/{importe.md => howto-importe.md} (98%) rename docs/{lokale-entwicklung.md => howto-lokale-entwicklung.md} (92%) rename docs/{rbac-permissions-playbook.md => howto-rbac-permissions-playbook.md} (98%) rename docs/{request-input-validation.md => howto-request-input-validation.md} (97%) rename docs/{agents/flow.md => reference-agents-flow.md} (97%) rename docs/{agents/overview.md => reference-agents-overview.md} (95%) rename docs/{agents/roles.md => reference-agents-roles.md} (97%) rename docs/{api.md => reference-api.md} (86%) rename docs/{benutzer-lifecycle-policy.md => reference-benutzer-lifecycle-policy.md} (98%) rename docs/{codex-prompts.md => reference-codex-prompts.md} (98%) rename docs/{02-domain-glossar.md => reference-domain-glossar.md} (85%) rename docs/{entwickler-checkliste.md => reference-entwickler-checkliste.md} (93%) rename docs/{frontend-css.md => reference-frontend-css.md} (98%) rename docs/{frontend-javascript.md => reference-frontend-javascript.md} (99%) rename docs/{konfiguration.md => reference-konfiguration.md} (99%) rename docs/{konventionen.md => reference-konventionen.md} (98%) rename docs/{lib-standards.md => reference-lib-standards.md} (97%) rename docs/{erste-schritte.md => tutorial-01-erste-schritte.md} (83%) rename docs/{00-systemueberblick.md => tutorial-02-systemueberblick.md} (78%) rename docs/{01-setup-und-erster-login.md => tutorial-03-setup-und-erster-login.md} (84%) rename docs/{03-architektur-request-flow.md => tutorial-04-architektur-request-flow.md} (92%) rename docs/{04-erste-aenderung-ui.md => tutorial-05-erste-aenderung-ui.md} (83%) rename docs/{05-erste-aenderung-backend.md => tutorial-06-erste-aenderung-backend.md} (84%) rename docs/{06-security-tenant-scope.md => tutorial-07-security-tenant-scope.md} (81%) rename docs/{07-api-erweitern.md => tutorial-08-api-erweitern.md} (80%) rename docs/{08-advanced-scheduler-sso.md => tutorial-09-advanced-scheduler-sso.md} (73%) diff --git a/agent-system/runs/DOCS-RESTRUCTURE-001/execution-report.json b/agent-system/runs/DOCS-RESTRUCTURE-001/execution-report.json new file mode 100644 index 0000000..167cfda --- /dev/null +++ b/agent-system/runs/DOCS-RESTRUCTURE-001/execution-report.json @@ -0,0 +1,121 @@ +{ + "task_id": "DOCS-RESTRUCTURE-001", + "plan_ref": "agent-system/runs/DOCS-RESTRUCTURE-001/plan.json", + "status": "done", + "changed_files": [ + { "path": "docs/index.md", "summary": "Rebuilt with exactly 4 Diataxis groups (Tutorials, How-to Guides, Explanation, Reference); all 42 files referenced once each." }, + { "path": "docs/tutorial-01-erste-schritte.md", "summary": "Renamed from erste-schritte.md; date updated to 2026-03-06; internal links migrated." }, + { "path": "docs/tutorial-02-systemueberblick.md", "summary": "Renamed from 00-systemueberblick.md; date updated; internal links migrated." }, + { "path": "docs/tutorial-03-setup-und-erster-login.md", "summary": "Renamed from 01-setup-und-erster-login.md; date updated; internal links migrated." }, + { "path": "docs/tutorial-04-architektur-request-flow.md", "summary": "Renamed from 03-architektur-request-flow.md; date updated; internal links migrated." }, + { "path": "docs/tutorial-05-erste-aenderung-ui.md", "summary": "Renamed from 04-erste-aenderung-ui.md; date updated; internal links migrated." }, + { "path": "docs/tutorial-06-erste-aenderung-backend.md", "summary": "Renamed from 05-erste-aenderung-backend.md; date updated; internal links migrated." }, + { "path": "docs/tutorial-07-security-tenant-scope.md", "summary": "Renamed from 06-security-tenant-scope.md; date updated; internal links migrated." }, + { "path": "docs/tutorial-08-api-erweitern.md", "summary": "Renamed from 07-api-erweitern.md; date updated; internal links migrated." }, + { "path": "docs/tutorial-09-advanced-scheduler-sso.md", "summary": "Renamed from 08-advanced-scheduler-sso.md; date updated; internal links migrated." }, + { "path": "docs/howto-erste-aenderung.md", "summary": "Renamed from erste-aenderung.md; date updated; internal links migrated." }, + { "path": "docs/howto-globale-suche.md", "summary": "Renamed from globale-suche.md; date updated." }, + { "path": "docs/howto-importe.md", "summary": "Renamed from importe.md; date updated." }, + { "path": "docs/howto-benutzerdefinierte-felder.md", "summary": "Renamed from benutzerdefinierte-felder.md; date updated." }, + { "path": "docs/howto-geplante-aufgaben.md", "summary": "Renamed from geplante-aufgaben.md; date updated." }, + { "path": "docs/howto-auth-sso-smoke-test.md", "summary": "Renamed from auth-sso-smoke-test.md; date updated." }, + { "path": "docs/howto-anfragelimits.md", "summary": "Renamed from anfragelimits.md; date updated." }, + { "path": "docs/howto-rbac-permissions-playbook.md", "summary": "Renamed from rbac-permissions-playbook.md; date updated." }, + { "path": "docs/howto-request-input-validation.md", "summary": "Renamed from request-input-validation.md; date updated." }, + { "path": "docs/howto-docker-lokal.md", "summary": "Renamed from docker-lokal.md; date updated." }, + { "path": "docs/howto-docker-produktiv.md", "summary": "Renamed from docker-produktiv.md; date updated." }, + { "path": "docs/howto-betriebscheck-doctor.md", "summary": "Renamed from betriebscheck-doctor.md; date updated." }, + { "path": "docs/howto-fehlerbehebung.md", "summary": "Renamed from fehlerbehebung.md; date updated." }, + { "path": "docs/howto-lokale-entwicklung.md", "summary": "Renamed from lokale-entwicklung.md; date updated; internal links migrated." }, + { "path": "docs/howto-dokumentation-erweitern.md", "summary": "Renamed from dokumentation-erweitern.md; IA section updated to Diataxis 4-quadrant model; naming convention documented; date updated; internal links migrated." }, + { "path": "docs/explanation-architektur.md", "summary": "Renamed from architektur.md; date updated; internal links migrated." }, + { "path": "docs/explanation-di-container.md", "summary": "Renamed from di-container.md; added Letzte Aktualisierung line." }, + { "path": "docs/explanation-sicherheitsmodell.md", "summary": "Renamed from sicherheitsmodell.md; date updated; internal links migrated." }, + { "path": "docs/explanation-einstellungen-speicherung.md", "summary": "Renamed from einstellungen-speicherung.md; date updated." }, + { "path": "docs/explanation-docker-betrieb.md", "summary": "Renamed from docker-betrieb.md; date updated; internal links migrated." }, + { "path": "docs/reference-domain-glossar.md", "summary": "Renamed from 02-domain-glossar.md; date updated; internal links migrated." }, + { "path": "docs/reference-api.md", "summary": "Renamed from api.md; date updated; internal links migrated." }, + { "path": "docs/reference-konfiguration.md", "summary": "Renamed from konfiguration.md; date updated." }, + { "path": "docs/reference-konventionen.md", "summary": "Renamed from konventionen.md; date updated." }, + { "path": "docs/reference-lib-standards.md", "summary": "Renamed from lib-standards.md; date updated; internal links migrated." }, + { "path": "docs/reference-benutzer-lifecycle-policy.md", "summary": "Renamed from benutzer-lifecycle-policy.md; date updated." }, + { "path": "docs/reference-frontend-css.md", "summary": "Renamed from frontend-css.md; date updated." }, + { "path": "docs/reference-frontend-javascript.md", "summary": "Renamed from frontend-javascript.md; date updated." }, + { "path": "docs/reference-entwickler-checkliste.md", "summary": "Renamed from entwickler-checkliste.md; date updated; internal links migrated." }, + { "path": "docs/reference-codex-prompts.md", "summary": "Renamed from codex-prompts.md; date updated." }, + { "path": "docs/reference-agents-overview.md", "summary": "Migrated from docs/agents/overview.md to top-level; added Letzte Aktualisierung line." }, + { "path": "docs/reference-agents-roles.md", "summary": "Migrated from docs/agents/roles.md to top-level; added Letzte Aktualisierung line." }, + { "path": "docs/reference-agents-flow.md", "summary": "Migrated from docs/agents/flow.md to top-level; added Letzte Aktualisierung line." }, + { "path": "tests/Architecture/CodexSkillsContractTest.php", "summary": "Updated 2 assertions to reference new slug docs/reference-codex-prompts.md instead of old docs/codex-prompts.md." } + ], + "guard_evidence": [ + { + "guard_id": "GR-UI-009", + "status": "pass", + "evidence": "No a11y regression: changes are purely Markdown restructuring (file renames, link updates, date normalization). No HTML, JS, CSS, or interactive UI components were touched." + }, + { + "guard_id": "GR-SEC-004", + "status": "pass", + "evidence": "rg for external asset patterns (![](https://...),