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

Improve TOML lesson data structures #10

Open
6 tasks
garrison opened this issue Jul 20, 2020 · 1 comment
Open
6 tasks

Improve TOML lesson data structures #10

garrison opened this issue Jul 20, 2020 · 1 comment
Labels
lesson structures TOML data structures representing the lessons

Comments

@garrison
Copy link
Contributor

Once the data structures for lessons are documented (#9), the data structures should be improved, and the documentation should be updated in coordination.

Currently, there are three separate lesson interactions:

  1. choice
  2. storybook
  3. podcast

These lesson interactions are unrelated, but they were stored in Ductus using the same data structure, which we called a "flashcard."

Here is a rough plan:

  • Identify any lessons that use multiple of the above interaction types. Are multiple interaction types ever used or actually needed?
  • Split the lessons into three types rather than having each lesson be type = "lesson" with the actual lesson type under [[interactions]].
  • Refactor the "choice" interaction to have multiple groups of cards, rather than dividers. This will be more pleasant and conceptually simpler when editing the TOML.
  • Remove headings where it is unnecessary. The role of columns is already hard-coded for storybook lessons, and the best structure for them might be even more straightforward.
  • Further improve the lesson TOML for each lesson type, with the goal of making it a pleasure to edit by hand.
  • Deal with media elements. We probably don't need both href and blob_href. The lesson elements might not be the best place for credit elements. (Perhaps they can be in a separate section of the TOML, or stored alongside the media elements themselves.)

In the end, we should make sure that the "grid" view continues to work for each lesson type when setting grid = true in a lesson's front matter.

@garrison garrison added the lesson structures TOML data structures representing the lessons label Jul 20, 2020
@garrison
Copy link
Contributor Author

As part of improving the "choice" lesson structure, we should allow an instructor to explicitly specify the "wrong" answers rather than having them come from the correct answers to other questions (see @wikey's #17 (comment)).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lesson structures TOML data structures representing the lessons
Projects
None yet
Development

No branches or pull requests

1 participant