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

[Feature Request] Support module, skill, and phrase comments #3284

Open
LoveIsGrief opened this issue Feb 9, 2024 · 1 comment
Open

[Feature Request] Support module, skill, and phrase comments #3284

LoveIsGrief opened this issue Feb 9, 2024 · 1 comment

Comments

@LoveIsGrief
Copy link

Some modules, skills, or phrases could do with comments from the course creators. Most obvious would comments about grammar.

There are two ways to achieve this:

  • an inline comment field in the YAML that takes a markdown string
  • a comment_file field that takes the name of a file at an expected path containing the markdown

Using markdown will allow the use of images, tables, and basically everything that markdown supports.

@kantord
Copy link
Owner

kantord commented Apr 28, 2024

I'm curious: how would you display these comments to the users?

I like the idea, though I think I am against adding the possibility to include features and longer text, for 2 reasons:

  • there is already a feature to display a large markdown document with explanations for a skill
  • displaying long text to the user while practicing a long skill could disrupt the flow of quickly practicing a lot of examples.

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