docs: redundante docs/user_documentation.md entfernen (Single Source)#28
Merged
Merged
Conversation
Es gab zwei Doku-Quellen: die ausgespielte public/documentation.html (In-App- Hilfe, via gh-pages deployed) und die nicht-ausgespielte docs/user_documentation.md. Letztere fuehrte dazu, dass eine Aktualisierung nicht beim Nutzer ankam. Die redundante Markdown-Datei ist jetzt entfernt; public/documentation.html ist die einzige Quelle. README-Verweis auf die ausgespielte Hilfe umgebogen.
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
2 participants
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.
Entfernt die redundante, nicht-ausgespielte Doku-Quelle, damit es nur noch eine gibt.
Hintergrund
Es existierten zwei Doku-Dateien:
public/documentation.html— die in der App verlinkte und per GitHub Pages deployte Hilfe (live).docs/user_documentation.md— eine Repo-interne Markdown-Datei, die nirgends ausgespielt wird.Genau diese Doppelung hat dazu geführt, dass ein Doku-Update (PR #25) nicht beim Nutzer ankam.
Änderung
docs/user_documentation.mdgelöscht.README.md-Verweis „Benutzerhandbuch" auf die ausgespielte Hilfe umgebogen undpublic/documentation.htmlals einzige Quelle benannt.Damit kann „falsche Datei editiert" nicht mehr passieren — es gibt nur noch
public/documentation.html.Verifikation
completed/success, d. h. die aktualisierte Hilfe ist aufgh-pageslive (anonymer Abruf scheitert nur, weil die Pages-Seite des privaten Repos Login verlangt).Labels
Other
🤖 https://claude.ai/code/session_01D2Pc4cAexeqUFrM1YonaJL
Generated by Claude Code