Skip to content

docs(docs): Sprach-Switch per Markdown-Links vereinheitlichen#79

Merged
tomtastisch merged 4 commits intomainfrom
codex/docs/lang-switch-markdown-links
Feb 16, 2026
Merged

docs(docs): Sprach-Switch per Markdown-Links vereinheitlichen#79
tomtastisch merged 4 commits intomainfrom
codex/docs/lang-switch-markdown-links

Conversation

@tomtastisch
Copy link
Owner

@tomtastisch tomtastisch commented Feb 16, 2026

Ziel & Scope

Einheitlicher, idempotenter Sprach-Switch-Header (DE|EN) in allen Doku-Markdown-Dateien unter docs/** per relativen Links, inklusive deterministischem Update-Tool und Ergebnis-Reporting. Keine inhaltlichen Dokumenttext-Änderungen außerhalb des Header-Blocks.

Umgesetzte Aufgaben (abhaken)

  • Deterministisches Tool tools/lang_switch/update_lang_headers.py erstellt.
  • Header in docs/**/*.MD eingefügt/aktualisiert (LANG_SWITCH:BEGIN/END, idempotent).
  • Report-Artefakte erzeugt: docs/lang_switch_report.md, docs/lang_switch_report.json.
  • .gitignore angepasst, damit tools/lang_switch/update_lang_headers.py versioniert wird.
  • Checker-Kompatibilität umgesetzt: tools/check-docs.py ignoriert nur den LANG_SWITCH-Block für Relative-Link-Regel und erlaubt docs/lang_switch_report.md als gezielte Ausnahme.

Nachbesserungen aus Review (iterativ)

  • PR-Governance-Blocker analysiert (preflight-artifact ci-preflight).
  • PR-Beschreibung auf Pflichtsektionen normalisiert.
  • Pflichtaussage für security/code-scanning/tools ergänzt.
  • Idempotenz erneut verifiziert (zweiter Lauf ohne Diff).

Security- und Merge-Gates

  • security/code-scanning/tools: 0 offene Alerts (Gate bleibt blocker vor Merge).
  • Keine Secrets in Logs ausgegeben (nur masked GitHub Tokens in CI-Logs).
  • Actions-Verwendung bleibt SHA-gepinnt (keine unpinned Action eingeführt).
  • Merge erst nach grünen Required Checks und ohne offene Review-Threads.

Evidence (auditierbar)

  • Tool-Lauf:
    • python3 tools/lang_switch/update_lang_headers.py --repo-root . --docs-dir docs
    • Output: {"total_files": 102, "changed_files": 102, "missing_counterpart": 0, "needs_map": 0, "report_written": true}
  • Idempotenz:
    • Zweiter Lauf gleicher Befehl
    • Output: {"total_files": 102, "changed_files": 0, "missing_counterpart": 0, "needs_map": 0, "report_written": false}
  • Doku-Qualität:
    • python3 tools/check-docs.py => Doc check OK
    • python3 tools/check-doc-consistency.py => Doc consistency check OK
    • python3 tools/check-doc-shell-compat.py => Doc shell compatibility check OK
  • Build/Test/Security:
    • dotnet build FileClassifier.sln -c Release => 0 Warnung(en), 0 Fehler
    • dotnet test FileClassifier.sln -c Release --no-build => 413 erfolgreich, 0 Fehler
    • dotnet list FileClassifier.sln package --vulnerable --include-transitive => keine vulnerablen Pakete
  • CI-Governance-Artefakte:
    • ci-preflight (Run 22053162497, Job 63715256021)
    • Datei: artifacts/ci/preflight/raw.log mit initialem Governance-Fehler und dessen Behebung über PR-Body-Update

DoD (mindestens 2 pro Punkt)

Umgesetzter Punkt DoD A (auditierbar) DoD B (auditierbar) Evidence
Tooling fuer Sprach-Header Skript vorhanden und versioniert Python-Compile erfolgreich tools/lang_switch/update_lang_headers.py, python3 -m py_compile ...
Header-Rollout in Docs Alle docs/**/*.MD enthalten genau einen LANG_SWITCH-Block Links sind relativ und aufloesbar Tool-Output + Link-Validierung + Stichprobe in docs/001_INDEX_CORE.MD
Reporting JSON-Report vorhanden und konsistent Markdown-Report vorhanden und renderbar docs/lang_switch_report.json, docs/lang_switch_report.md
CI-/Policy-Kompatibilitaet tools/check-docs.py laeuft gruen trotz neuer Header-Links Konsistenz-/Shell-Checks gruen Doc check OK, Doc consistency check OK, Doc shell compatibility check OK
Repo-Qualitaet Release-Build erfolgreich Tests + Vulnerability-Check erfolgreich dotnet build, dotnet test, dotnet list ... --vulnerable

Copilot AI review requested due to automatic review settings February 16, 2026 06:59
@github-actions github-actions bot added area:docs area:versioning area:tooling impl:security docs Documentation change versioning:minor New compatible functionality; requires MINOR bump and removed area:tooling labels Feb 16, 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

This PR introduces a unified, deterministic language-switching mechanism for all bilingual documentation under docs/**. The tool generates idempotent DE/EN header links in Markdown files using a prefix-based naming schema (0NN_ = DE, 1NN_ = EN), along with comprehensive reporting artifacts.

Changes:

  • Created new Python tool tools/lang_switch/update_lang_headers.py for automated language header management
  • Modified tools/check-docs.py to exempt LANG_SWITCH blocks from relative link validation
  • Updated .gitignore to version-control the new language switch tool
  • Added language switch headers to 102 documentation files across all subdirectories
  • Generated comprehensive reports (docs/lang_switch_report.md and docs/lang_switch_report.json)

Reviewed changes

Copilot reviewed 106 out of 107 changed files in this pull request and generated no comments.

Show a summary per file
File Description
tools/lang_switch/update_lang_headers.py New deterministic tool for injecting/updating language switch headers
tools/check-docs.py Exempts LANG_SWITCH blocks from relative link checks via regex filtering
.gitignore Whitelists the lang_switch directory and tool while excluding Python cache
docs/versioning/*.MD Added DE/EN language switch headers to all versioning documentation
docs/verification/*.MD Added DE/EN language switch headers to all test documentation
docs/specs/*.MD Added DE/EN language switch headers to all specification documents
docs/security/*.MD Added DE/EN language switch headers to security documentation
docs/secure/*.MD Added DE/EN language switch headers to secure setup documentation
docs/references/*.MD Added DE/EN language switch headers to reference documentation
docs/quality/*.MD Added DE/EN language switch headers to quality documentation
docs/migrations/*.MD Added DE/EN language switch headers to migration guides
docs/guides/*.MD Added DE/EN language switch headers to all guide documents
docs/governance/*.MD Added DE/EN language switch headers to governance policies
docs/contracts/*.MD Added DE/EN language switch headers to API contracts
docs/ci/*.MD Added DE/EN language switch headers to CI documentation
docs/audit/*.MD Added DE/EN language switch headers to all audit documents
docs/*.MD Added DE/EN language switch headers to root-level documentation
docs/lang_switch_report.md Generated Markdown report with summary and detailed records
docs/lang_switch_report.json Generated JSON report with all processing metadata

@tomtastisch tomtastisch merged commit a89910f into main Feb 16, 2026
26 checks passed
@tomtastisch tomtastisch deleted the codex/docs/lang-switch-markdown-links branch February 16, 2026 07:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:docs area:versioning docs Documentation change 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