DSEDataSourceExplorer
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.

Supported language folders (current project)

Fallback behavior

When the current UI language does not have an exact file, DSE tries:

  1. Exact culture folder (for example fr-CA, if it exists)
  2. Two-letter language folder (fr)
  3. English (en)

Add or update a topic

  1. Edit or create the English file first (for example Help/en/help.readme.md)
  2. Add the same topic file name in the other language folders
  3. Translate the content while keeping the same markdown structure
  4. If this is a new visible topic, add the topic ID to HelpCenterViewModel._topicIds
  5. Rebuild and test the Help Center

Authoring guidelines

Tip

You can open the help folder directly from the Help Center using the Open Folder button, then edit the markdown files and rebuild.