DSE 1.0.1
Help Center README
Welcome to the DSE Help Center. This topic explains how the in-app markdown help system is organized and how to add/update translated help files.
What this help system is
DSE loads help topics from markdown files stored under the Help folder next to the app. Each language has its own folder, and each topic uses the same file name across languages.
- Folder example:
Help/en - Topic file example:
help.quickstart.md
Supported language folders (current project)
en— Englishes— Spanishfr— Frenchru— Russianar— Arabiczh-Hans— Chinese (Simplified)
Fallback behavior
When the current UI language does not have an exact file, DSE tries:
- Exact culture folder (for example
fr-CA, if it exists) - Two-letter language folder (
fr) - English (
en)
Add or update a topic
- Edit or create the English file first (for example
Help/en/help.readme.md) - Add the same topic file name in the other language folders
- Translate the content while keeping the same markdown structure
- If this is a new visible topic, add the topic ID to
HelpCenterViewModel._topicIds - Rebuild and test the Help Center
Authoring guidelines
- Start with a
#heading (used as the Help topic title in the list) - Keep sections short and practical
- Use bullet lists for steps
- Prefer stable names and paths so translations stay aligned
Tip
You can open the help folder directly from the Help Center using the Open Folder button, then edit the markdown files and rebuild.