docs(doku): Markdown an Ist-Code anpassen#77
Merged
tomtastisch merged 2 commits intomainfrom Feb 15, 2026
Merged
Conversation
Closed
6 tasks
Contributor
There was a problem hiding this comment.
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Ziel & Scope
Ziel: Gesamte Markdown-Dokumentation an den aktuellen Ist-Code anpassen (Inhalt, Beispiele, Begriffe, Mermaid-Diagramme) ohne Code-/Workflow-/Config-Aenderungen.
Scope:
Nicht im Scope (explizit eingehalten):
SECURITY.mdist eingefroren und wurde nicht angefasst.Umgesetzte Aufgaben (abhaken)
docs/ci/001_PIPELINE_CI.MD).docs/ci/002_NUGET_TRUSTED_PUBLISHING.MD,docs/021_USAGE_NUGET.MD).docs/governance/001_POLICY_CI.MD).docs/governance/006_INDEX_CI_RULES.MD).docs/guides/002_GUIDE_DATATYPE.MD).git showergaenzt (docs/migrations/001_HASHING_RENAME.MD).docs/audit/000_HASHING_BASELINE.MD).SECURITY.mdPfad praezisiert (docs/audit/011_SECURITY_BENCHMARK.MD).docs/audit/013_SCORECARD_GOVERNANCE_ALERT_MAPPING.MD).docs/references/001_REFERENCES_CORE.MD).docs/versioning/002_HISTORY_VERSIONS.MD).src/FileClassifier.App/README.md).Nachbesserungen aus Review (iterativ)
Security- und Merge-Gates
preflight,version-policy,build,api-contract,pack,consumer-smoke,package-backed-tests,security-nuget,tests-bdd-coverage.security/code-scanning/toolsmuss0 offene Alertsmelden (Blocker).SECURITY.md(Repo-Contract).Evidence (auditierbar)
Alle Befehle lokal ausgefuehrt, Exit-Code jeweils
0:python3 tools/check-docs.pypython3 tools/check-doc-consistency.pypython3 tools/check-doc-shell-compat.pybash tools/ci/bin/run.sh docs-links-fullpython3 - <<'PY' ...(fence-scan ueber alle Markdown-Dateien; Ergebnis: OK)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
python3 tools/check-doc-consistency.py(OK)python3 tools/check-docs.py(OK)Punkt B: Diagramme/Blöcke syntaktisch sauber (render-faehig)
python3 tools/check-docs.py(OK)Punkt C: Link- und Shell-Beispiel-Qualitaet
bash tools/ci/bin/run.sh docs-links-full(OK)python3 tools/check-doc-shell-compat.py(OK)