Skip to content

docs(doku): Markdown an Ist-Code anpassen#77

Merged
tomtastisch merged 2 commits intomainfrom
codex/docs/doc-sync-ist-stand
Feb 15, 2026
Merged

docs(doku): Markdown an Ist-Code anpassen#77
tomtastisch merged 2 commits intomainfrom
codex/docs/doc-sync-ist-stand

Conversation

@tomtastisch
Copy link
Owner

Ziel & Scope

Ziel: Gesamte Markdown-Dokumentation an den aktuellen Ist-Code anpassen (Inhalt, Beispiele, Begriffe, Mermaid-Diagramme) ohne Code-/Workflow-/Config-Aenderungen.

Scope:

  • Nur .md/.MD geaendert (Text/Struktur/Beispiele/Mermaid).
  • Konsistenz zwischen Code und Doku hergestellt; historische Inhalte explizit als Snapshot an Commits gepinnt.

Nicht im Scope (explizit eingehalten):

  • Keine Aenderungen an Code/Logik/Workflows/Configs/Tests.
  • SECURITY.md ist eingefroren und wurde nicht angefasst.

Umgesetzte Aufgaben (abhaken)

  • CI/Pipeline-Doku an reale Workflow- und Gate-Logik angepasst (docs/ci/001_PIPELINE_CI.MD).
  • Trusted Publishing/NuGet Doku: Pfade konsistent ohne fuehrenden Slash (docs/ci/002_NUGET_TRUSTED_PUBLISHING.MD, docs/021_USAGE_NUGET.MD).
  • Governance-Doku: Index-Referenz korrigiert (docs/governance/001_POLICY_CI.MD).
  • Governance-Index: irrefuehrende NOTE entfernt (docs/governance/006_INDEX_CI_RULES.MD).
  • Datatype-Guide: Beispiel so angepasst, dass es keine nicht-existierenden Artefakte behauptet (docs/guides/002_GUIDE_DATATYPE.MD).
  • Migration-Doku: historische Pfade mit Verifikationshinweis via git show ergaenzt (docs/migrations/001_HASHING_RENAME.MD).
  • Audit: Hashing-Baseline als historischer Snapshot mit fixen Commit-Refs dokumentiert (docs/audit/000_HASHING_BASELINE.MD).
  • Audit: Security Benchmark Hinweis bzgl. SECURITY.md Pfad praezisiert (docs/audit/011_SECURITY_BENCHMARK.MD).
  • Audit: Code-Scanning Gate (Label-Ausnahme) dokumentiert (docs/audit/013_SCORECARD_GOVERNANCE_ALERT_MAPPING.MD).
  • References: Link-Policy und ReasonCode-Tabelle an Ist-Code angepasst (docs/references/001_REFERENCES_CORE.MD).
  • Versioning-History: aktuelles Release/Tag nachgezogen (docs/versioning/002_HISTORY_VERSIONS.MD).
  • App-README: Paket-/Bibliotheksnamen an Ist-Zustand angepasst (src/FileClassifier.App/README.md).

Nachbesserungen aus Review (iterativ)

  • Review-Kommentare einarbeiten (falls vorhanden).
  • PR-Beschreibung/Checklisten anhand von Review-Feedback aktualisieren.

Security- und Merge-Gates

  • Required checks (Branch-Protection): preflight, version-policy, build, api-contract, pack, consumer-smoke, package-backed-tests, security-nuget, tests-bdd-coverage.
  • Code-Scanning Gate: security/code-scanning/tools muss 0 offene Alerts melden (Blocker).
  • Keine Aenderungen an SECURITY.md (Repo-Contract).

Evidence (auditierbar)

Alle Befehle lokal ausgefuehrt, Exit-Code jeweils 0:

  • python3 tools/check-docs.py
  • python3 tools/check-doc-consistency.py
  • python3 tools/check-doc-shell-compat.py
  • bash tools/ci/bin/run.sh docs-links-full
  • Mermaid/Code-Fence-Closure: python3 - <<'PY' ... (fence-scan ueber alle Markdown-Dateien; Ergebnis: OK)
  • Scope-Guard: git diff --name-only origin/main...HEAD | rg -v '\\.(md|MD)$' (keine Treffer)

DoD (mindestens 2 pro Punkt)

Punkt A: Doku-Inhalt konsistent zum Ist-Code

  • DoD-A1: python3 tools/check-doc-consistency.py (OK)
  • DoD-A2: python3 tools/check-docs.py (OK)

Punkt B: Diagramme/Blöcke syntaktisch sauber (render-faehig)

  • DoD-B1: Mermaid/Code-Fence-Closure Scan (OK)
  • DoD-B2: python3 tools/check-docs.py (OK)

Punkt C: Link- und Shell-Beispiel-Qualitaet

  • DoD-C1: bash tools/ci/bin/run.sh docs-links-full (OK)
  • DoD-C2: python3 tools/check-doc-shell-compat.py (OK)

Copilot AI review requested due to automatic review settings February 15, 2026 20:34
@github-actions github-actions bot added area:docs area:versioning impl:security feature New compatible feature or datatype versioning:minor New compatible functionality; requires MINOR bump labels Feb 15, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Diese PR aktualisiert die bestehende Markdown-Dokumentation, sodass Begriffe, Beispiele, Pfade/Links und CI-/Governance-Beschreibungen dem aktuellen Ist-Stand im Repository entsprechen (ohne Code-/Workflow-/Config-Änderungen).

Changes:

  • Dokumentations-Drift bereinigt (CI-Pipeline/Contexts, Governance-Index-Referenzen, NuGet/Workflow-Pfade).
  • Referenzen/ReasonCodes und interne Link-Targets an aktuelle Code-Realität angepasst.
  • Audit-/Migration-Dokumente präzisiert (historische Snapshots/Verifikation via gepinnter Commits).

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
src/FileClassifier.App/README.md Bibliotheksname im CLI-README auf aktuellen Paket-/Namespace-Namen aktualisiert.
docs/versioning/002_HISTORY_VERSIONS.MD Versions-/Release-Historie auf aktuellen Tag/Commit-Stand nachgezogen.
docs/references/001_REFERENCES_CORE.MD ReasonCode-Tabelle erweitert und Referenz-Links auf stabile Targets aktualisiert.
docs/migrations/001_HASHING_RENAME.MD Migration mit Hinweis zur repo-lokalen Verifikation historischer Pfade ergänzt.
docs/guides/002_GUIDE_DATATYPE.MD Beispiel angepasst, sodass keine nicht-existierenden Artefakte behauptet werden.
docs/governance/006_INDEX_CI_RULES.MD Irreführende NOTE entfernt.
docs/governance/001_POLICY_CI.MD Index-Referenzen auf den aktuellen Governance-Index korrigiert.
docs/ci/002_NUGET_TRUSTED_PUBLISHING.MD Workflow-Pfade konsistent ohne führenden Slash dokumentiert.
docs/ci/001_PIPELINE_CI.MD CI-Topology/Contexts/Evidence auf aktuellen Workflow-Stand (Placeholder + version-convergence) angepasst.
docs/audit/013_SCORECARD_GOVERNANCE_ALERT_MAPPING.MD Code-Scanning-Gate inkl. Label-Ausnahme (area:qodana) dokumentiert.
docs/audit/011_SECURITY_BENCHMARK.MD SECURITY.md-Pfadannahme präzisiert (repo-root vs. .github/SECURITY.md).
docs/audit/000_HASHING_BASELINE.MD Hashing-Baseline als historischer Snapshot mit gepinntem Commit + Verifikationskommandos neu strukturiert.
docs/021_USAGE_NUGET.MD Workflow-Pfad in Usage-Doku konsistent ohne führenden Slash dokumentiert.

@tomtastisch tomtastisch enabled auto-merge (squash) February 15, 2026 20:47
@tomtastisch tomtastisch merged commit af1686d into main Feb 15, 2026
26 checks passed
@tomtastisch tomtastisch deleted the codex/docs/doc-sync-ist-stand branch February 15, 2026 20:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:docs area:versioning feature New compatible feature or datatype impl:security versioning:minor New compatible functionality; requires MINOR bump

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant