meta-issue: Improve user and developer documentation

[erikmd]

Related user(s):

@yurug, @erikmd

Related issue(s) or PR(s):

• docs: Improve the tutorial howto-deploy-learn-ocaml-statically #504
• Question: How do I see student solutions? #514
• Bug: Improve developer documentation (Learnocaml_api.request) #494

Related project scope(s):

documentation

The problem:

• @AltGr Reply Question: what is the 1.0 alternative to private grader helper modules a la depend.txt? #588
• @yurug Document operational semantics of constr of Learnocaml_api.request
• @erikmd Better document availability of static binaries (learn-ocaml serve pas besoin switch) docs: Improve the tutorial howto-deploy-learn-ocaml-statically #504
• @erikmd Document the procedure to fetch/use macOS binaries
• @erikmd Better document markdown-to-html (feature already in master)
• @yurug Add Markdown badges in the README?
• @yurug Mention https://github.com/learn-ocaml-community/teaching-feedback in the README
• @erikmd Improve dev. documentation (e.g., mentioning direnv, magit, git prompt…)
• Address Note: we may want to update the opam-switch command to build learn-ocaml dependencies #591
• Address Bug: Stack overflows on Safari #524
• Address Feature: document https://learn-ocaml.readthedocs.io/en/master/ #573
• @AltGr Add documentation on the teacher board
  cf. e.g. Question: How do I see student solutions? #514 (comment)

Wanted solution:

No response

Considered alternatives:

No response

Additional context:

No response