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

Accompanying text for a variation #571

Open
xxdavid opened this issue Jan 31, 2025 · 1 comment
Open

Accompanying text for a variation #571

xxdavid opened this issue Jan 31, 2025 · 1 comment

Comments

@xxdavid
Copy link
Contributor

xxdavid commented Jan 31, 2025

Hi Christian!

Sometimes, it would be useful to provide some text next to a variation, e.g., some further comments on how to use the component in the way the variation uses it. Of course, this can go into documentation, but showing it alongside the variation might be better in some cases.

I think it could be displayed between the variation's title and preview. Ideally, it should support Markdown formatting and syntax highlighting of code blocks, but simple <pre> could be also okay.

I am not sure how to name it though. If the description field wasn't taken, I would suggest that. Things that come to my mind are: note, comment, narrative, gloss, and annotation.

What do you think?

@cblavier
Copy link
Contributor

I agree that if description wasn't already taken, it would have been a good fit :)
Let's go for note then!

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

2 participants