Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FREQ: Plz provide sample settings as TEXT, not IMAGES, plus "current dictionary"/"legend" incl. defaults. #30

Open
gwiede opened this issue Feb 18, 2025 · 0 comments

Comments

@gwiede
Copy link

gwiede commented Feb 18, 2025

Really appreciate the extension, and think it has a lot of promise, but it has a few significant issues I've encountered during install and initial config:

The Problems: You provide your sample settings as images, which requires manual retyping for users trying to create them in their own settings -- opening risk of typos, or them not perfectly matching the spelling you're using, when ambiguous.

Even setting aside the rather significant copy&paste issue, every extension that uses settings should provide a full "dictionary" of their settings all together in one spot, with explanations. That dictionary also provides users another text-format fallback where they can copy&paste them as needed, to make absolutely sure they've got the names you need, even if you have typos/different spellings. Last but not least, that dictionary serves as a "canonical list" of available settings and their defaults (remaining current when the available settings change). Without that, as time passes, and settings come and go, it quickly gets confusing which are still "valid", which are not, and whether their defaults are the same or changed.

The Fixes:

  1. Provide text-format versions with description of "example common user settings", not images. This gives the user something they can copy&paste from into their own user settings as needed.

  2. As described above, towards the end of the extension details, provide a full table of all currently-available settings, their default values (and type where it may not be obvious), and a brief explanation of what they control (and what different values mean, in multiple-choice cases).

Thanks muchly!

@gwiede gwiede changed the title FREQ: Plz provide sample settings as TEXT, not IMAGES! FREQ: Plz provide sample settings as TEXT, not IMAGES, plus "current dictionary"/"legend" incl. defaults. Feb 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant