search

ocaml-gospel / gospel

A tool-agnostic formal specification language for OCaml.
https://ocaml-gospel.github.io/gospel
MIT License
128 stars 16 forks source link

Update documentation #323

Closed shym closed 1 year ago

shym commented 1 year ago

This PR updates the documentation. It is based on #253, as it changes the fixed version of the documentation, obviously.

It does a large reorganisation of the language reference part. It addresses the comments in #57 that were not yet taken into account.

Closes #322

It should contribute to close #293

shym commented 1 year ago

Latest updates to that PR bring among other things a build of the documentation as an CI artifact, so that the actual rendering can be checked locally (it requires a web server, as docusaurus URLs are not real paths) before merging to main and actually deploying it.

shym commented 1 year ago

Latest update: I added the suggested link from the Welcome to Stdlib, and dropped the Tips page, after moving the tips it contained to the relevant sections.