Hints

Hints

SD.Next hints system is based on the single JSON file: html/locale_en.json

Structure of the file is simple: For each visible UI label, there is a corresponding hint that is displayed when user hovers over the label.

Example: generate button:

{"id":"","label":"Generate","localized":"","hint":"Start processing"}

See Localization document for more details

Editing

By editing the hints file, you can add or modify hints displayed in the UI for each item

Warning

Do not change any of the other fields in the file, only the hint field should be modified

Important

Items that are part of "missing" section are auto-created items with default hint only
If you want to customize/improve them, move them to the correct section and add your hint,
do not leave them in missing section as it will be overwritten on the next update

Validation

Warning

All hints updates should be validated before submitting

Before submitting updates, validate your edits:
Save it locally and run python cli/validate-locale.py

Optional: If you want to run full validation,
start you local SDNext server, open browser console and run analyzeHints() function
It will analyze all hints and print detailed report in the console:

Contribution

Best way to submit additions/changes is to create GitHub PR with changes to that file
Alternatively, you can use discussions or issue tracker to suggest changes and they will be applied manually