Skip to content

Commit 86aa4ea

Browse files
tomtastischgithub-actions[bot]
tomtastisch
and
github-actions[bot]
authored
docs(doku): Bilinguale 0NN/1NN Dokumentation vervollstaendigen (#78)
* docs(bilingual): DE primary + EN mirrors (batch 1) * docs(bilingual): EN translations + link alignment (batch 2) * docs(bilingual): EN fixes fuer Architektur + Audit-Docs * docs(bilingual): mapping report + evidence finalisieren * chore(ci): trigger PR governance --------- Co-authored-by: GitHub Copilot Agent <github-actions[bot]@users.noreply.github.com>
1 parent af1686d commit 86aa4ea

68 files changed

Lines changed: 4935 additions & 471 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/021_USAGE_NUGET.MD‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# NuGet Usage
1+
# NuGet Nutzung
22

3-
## A) Purpose
3+
## A) Zweck
44
`Tomtastisch.FileClassifier` stellt die öffentliche Bibliotheksoberfläche für Dateityperkennung, sichere Archivverarbeitung, Byte-Materialisierung und deterministische Hashing-Nachweise bereit.
55

6-
## B) Install (Consumer)
6+
## B) Installation (Consumer)
77
```bash
88
dotnet add package Tomtastisch.FileClassifier --version X.Y.Z
99
```
@@ -18,7 +18,7 @@ Version-Pinning:
1818
- Für Releases gilt SVT: Git-Tag `vX.Y.Z` entspricht Paketversion `X.Y.Z`.
1919
- Consumer sollten exakt auf die freigegebene Version pinnen.
2020

21-
## C) Minimal Usage (Consumer)
21+
## C) Minimalbeispiel (Consumer)
2222
```csharp
2323
using Tomtastisch.FileClassifier;
2424

@@ -33,7 +33,7 @@ if (detected.Kind == FileKind.Pdf)
3333
}
3434
```
3535

36-
## D) Verification (Consumer)
36+
## D) Verifikation (Consumer)
3737
Lokale Paketprüfung (nur Paketmetadata gegen Erwartung):
3838
```bash
3939
EXPECTED_VERSION=X.Y.Z VERIFY_ONLINE=0 bash tools/ci/verify_nuget_release.sh

‎docs/101_INDEX_CORE.MD‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Documentation Index
2+
3+
## 1. Purpose
4+
Central entry point for all project documentation, grouped by responsibility areas.
5+
6+
## 2. Standards and Guardrails
7+
- Documentation standard (mandatory): [Documentation Standard (SSOT)](https://github.com/tomtastisch/FileClassifier/blob/main/docs/governance/104_POLICY_DOCUMENTATION.MD)
8+
- CI and quality evidence: [CI Pipeline (SSOT)](https://github.com/tomtastisch/FileClassifier/blob/main/docs/ci/101_PIPELINE_CI.MD)
9+
- Auto labeling and auto versioning: [Auto Labeling and Auto Versioning (SSOT)](https://github.com/tomtastisch/FileClassifier/blob/main/docs/versioning/104_POLICY_LABELING.MD)
10+
- Test documentation (BDD): [Test Documentation (BDD)](https://github.com/tomtastisch/FileClassifier/blob/main/docs/verification/101_INDEX_TESTS.MD)
11+
12+
## 3. Core Architecture (SSOT)
13+
1. [01 - API Functions](https://github.com/tomtastisch/FileClassifier/blob/main/docs/110_API_CORE.MD)
14+
2. [02 - Overall Architecture and Flows](https://github.com/tomtastisch/FileClassifier/blob/main/docs/120_ARCH_CORE.MD)
15+
3. [03 - References](https://github.com/tomtastisch/FileClassifier/blob/main/docs/references/101_REFERENCES_CORE.MD)
16+
4. [04 - EvidenceHashing API Contract](https://github.com/tomtastisch/FileClassifier/blob/main/docs/contracts/101_CONTRACT_HASHING.MD)
17+
5. [DIN-oriented Specification (DE) - FileTypeDetection](https://github.com/tomtastisch/FileClassifier/blob/main/docs/specs/101_SPEC_DIN.MD)
18+
6. [Production Readiness Checklist - FileTypeDetection](https://github.com/tomtastisch/FileClassifier/blob/main/docs/quality/101_CHECKLIST_PRODUCTION.MD)
19+
7. [Secure Hash Key Setup (HMAC)](https://github.com/tomtastisch/FileClassifier/blob/main/docs/secure/101_HMAC_KEY_SETUP.MD)
20+
21+
## 4. Versioning and Governance
22+
1. [Versioning and Release Policy (SSOT)](https://github.com/tomtastisch/FileClassifier/blob/main/docs/versioning/101_POLICY_VERSIONING.MD)
23+
2. [Version Line (Commit -> Version)](https://github.com/tomtastisch/FileClassifier/blob/main/docs/versioning/102_HISTORY_VERSIONS.MD)
24+
3. [Changelog](https://github.com/tomtastisch/FileClassifier/blob/main/docs/versioning/103_CHANGELOG_RELEASES.MD)
25+
4. [Labeling Ownership](https://github.com/tomtastisch/FileClassifier/blob/main/docs/governance/102_POLICY_LABELING.MD)
26+
27+
## 5. Guides and Implementation Playbooks
28+
1. [Guides - Change Playbooks](https://github.com/tomtastisch/FileClassifier/blob/main/docs/guides/100_INDEX_GUIDES.MD)
29+
2. [Playbook: Create and Adjust Options](https://github.com/tomtastisch/FileClassifier/blob/main/docs/guides/101_GUIDE_OPTIONS.MD)
30+
3. [Playbook: Extend New Datatypes and API Models](https://github.com/tomtastisch/FileClassifier/blob/main/docs/guides/102_GUIDE_DATATYPE.MD)
31+
32+
## 5.1 Migration Notes
33+
1. [Migration: Hashing Rename](https://github.com/tomtastisch/FileClassifier/blob/main/docs/migrations/101_HASHING_RENAME.MD)
34+
35+
## 6. Tests and Evidence Documents
36+
1. [Test Matrix - Deterministic Hashing](https://github.com/tomtastisch/FileClassifier/blob/main/docs/verification/104_MATRIX_HASHING.MD)
37+
2. [BDD Catalog (German, canonical)](https://github.com/tomtastisch/FileClassifier/blob/main/docs/verification/103_CATALOG_BDD.MD)
38+
3. [BDD Execution and Gherkin Flow](https://github.com/tomtastisch/FileClassifier/blob/main/docs/verification/102_FLOW_BDD.MD)
39+
40+
## 7. Module-Local Documentation
41+
- [FileTypeDetection Module](https://github.com/tomtastisch/FileClassifier/blob/main/src/FileTypeDetection/README.md)
42+
- [Index - Detection](https://github.com/tomtastisch/FileClassifier/blob/main/src/FileTypeDetection/Detection/README.md)
43+
- [Index - Infrastructure](https://github.com/tomtastisch/FileClassifier/blob/main/src/FileTypeDetection/Infrastructure/README.md)
44+
- [Index - Configuration](https://github.com/tomtastisch/FileClassifier/blob/main/src/FileTypeDetection/Configuration/README.md)
45+
- [Index - Abstractions](https://github.com/tomtastisch/FileClassifier/blob/main/src/FileTypeDetection/Abstractions/README.md)
46+
- [Abstractions Detection Module](https://github.com/tomtastisch/FileClassifier/blob/main/src/FileTypeDetection/Abstractions/Detection/README.md)
47+
- [Abstractions Archive Module](https://github.com/tomtastisch/FileClassifier/blob/main/src/FileTypeDetection/Abstractions/Archive/README.md)
48+
- [Abstractions Hashing Module](https://github.com/tomtastisch/FileClassifier/blob/main/src/FileTypeDetection/Abstractions/Hashing/README.md)
49+
- [README](https://github.com/tomtastisch/FileClassifier/blob/main/src/FileClassifier.App/README.md)
50+
- [README](https://github.com/tomtastisch/FileClassifier/blob/main/tests/FileTypeDetectionLib.Tests/README.md)
51+
52+
## 8. Maintenance Process
53+
Mandatory check for documentation changes:
54+
```bash
55+
python3 tools/check-docs.py
56+
```
57+
58+
## Documentation Maintenance Checklist
59+
- [ ] Content verified against current code state.
60+
- [ ] Links and anchors checked with `python3 tools/check-docs.py`.
61+
- [ ] Examples/commands verified locally.
62+
- [ ] References to SSOT documents kept consistent.

0 commit comments

Comments
 (0)