learn-ocaml icon indicating copy to clipboard operation
learn-ocaml copied to clipboard

Introduction tab in exercise menu

Open lyrm opened this issue 7 years ago • 1 comments

Here is a little suggestion to improve exercise readability.

On paper, it is pretty usual for a group of exercises to share an introduction. To be able to do the same with learn-ocaml, a basic solution is to copy the introduction at the beginning of the first exercise but this makes this exercise less readable and then it is difficult to reach introduction from following exercises.

A more practical possibility could be to add a tab between the title of the exercise group and the first exercise tab (in exercises menu) that either links to a page with the corresponding text or can be unfold to read the introduction.

However, that would probably require to add a specific field in index.json and a file (.html ou .mk) in each exercise directory and break some retro-compatibility...

lyrm avatar Jul 17 '18 13:07 lyrm

Belated thanks for the suggestions! (and sorry that we didn't answer earlier)

While I acknowledge the use case, I believe that the current features of learn-ocaml (version 1.0.0 then 1.1.0) could suffice: one could just create a learn-ocaml lesson, containing several hyperlinks to the various exercises, as well as backref links in the exercises' descr.md.

Otherwise, the WIP feature of "multi-part exercises" (the design of which being complete, albeit not the implem.) could help:

  • cf. issue #331

erikmd avatar Jan 26 '25 21:01 erikmd