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

Add references to command modules #2286

Open
bcoles opened this issue Jan 24, 2022 · 2 comments
Open

Add references to command modules #2286

bcoles opened this issue Jan 24, 2022 · 2 comments

Comments

@bcoles
Copy link
Collaborator

bcoles commented Jan 24, 2022

Often command module descriptions contain HTML (which kinda sucks).

This is occasionally used for formatting, which is fine.

There are many instances where the description only uses HTML to include links.

It would make much more sense to define a references: key in the module config YAML file to contain an array of reference URLs.

The admin UI should also be updated to display the reference URLs.

@DeezyE
Copy link
Contributor

DeezyE commented Jan 24, 2022

We would then advise that no HTML used in description, correct?
Is there any other reason to have html in description?

@bcoles
Copy link
Collaborator Author

bcoles commented Jan 25, 2022

We would then advise that no HTML used in description, correct? Is there any other reason to have html in description?

Unfortunately we don't have much choice. Formatting inside the description is useful and HTML is the easiest approach.

Links are long and there's no need to have them inside the description.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants