Skip to content
This repository was archived by the owner on Feb 15, 2022. It is now read-only.

Imitate "Tutorial - Basics" tutorial page #224

Closed
ghost opened this issue Mar 25, 2021 · 7 comments
Closed

Imitate "Tutorial - Basics" tutorial page #224

ghost opened this issue Mar 25, 2021 · 7 comments

Comments

@ghost
Copy link

ghost commented Mar 25, 2021

Implement https://github.com/ocaml/ocaml.org/blob/master/site/learn/tutorials/basics.md

This issue can benefit from or inform the implementation of #222

@ghost ghost self-assigned this Mar 25, 2021
@ghost ghost mentioned this issue Mar 31, 2021
@ghost
Copy link
Author

ghost commented Mar 31, 2021

Missing functionality:

  • inject ocaml version from process call - manually inject for now
  • evaluate ocamltop snippets and inject output - manually inject for now
  • syntax highlight for ocaml, console, and c - Implement code highlighting #137 tracking this

Loose ends:

@ghost
Copy link
Author

ghost commented Mar 31, 2021

Start working on front matter parsing noted in #222 and make use of it here.

@ghost
Copy link
Author

ghost commented Apr 3, 2021

evaluate ocamltop snippets and inject output - manually inject for now

Once this has been done, close this issue and create any remaining follow-up tasks

@ghost
Copy link
Author

ghost commented Apr 3, 2021

The main implementation and

inject ocaml version from process call - manually inject for now

were done in #252

@agarwal agarwal unassigned ghost Apr 22, 2021
@ghost
Copy link
Author

ghost commented Apr 27, 2021

This tutorial has some code blocks that need code highlighting, but do not need to be evaluated by the ocaml compiler. As an example, the tutorial has the following

repeated : string -> int -> string

This is incompatible with ocaml-mdx code block evaluation. The example could be changed to evaluate the symbol repeated, or we could introduce a new annotation for code blocks such as ocaml-highlight-only.

@ghost
Copy link
Author

ghost commented May 1, 2021

For simplicity, I suggest we use the approach of rewriting tutorials to always use ocaml snippets that can be evaluated in the ocaml top level.

Also, we need to fix some of the ocaml snippets to rely on a prelude.ml, instead of inlining the necessary definitions.

Once those two items are addressed, we can close this issue.

@ghost
Copy link
Author

ghost commented May 13, 2021

The tutorials are moving to ood, so this issue is no longer relevant.

@ghost ghost closed this as completed May 13, 2021
This issue was closed.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

0 participants