Update documentation #323
Merged
Update documentation #323
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
shym
force-pushed
the
documentation-updates
branch
2 times, most recently
from
b957844
to
27a1757
Compare
In particular, use "pieces" (of information, ...) rather than "bits", to avoid the ambiguity
While at it, sort keywords alphabetically
Clauses are expected in a fixed order in the grammar
The content of that section is not really a specification (the grammar is partial and it does not say enough about the semantics) so use a more generic title
Extract from "Locations" the syntax information (ie @) that new users would care about first
Rename "Terms and formulae" subsection into "Expressions" Describe in more details the differences between Gospel and OCaml expressions Remove formal grammars as they are not really up-to-date
Document scope limitation
pages/faq.md is never rendered (and it is pretty empty anyway)
shym
force-pushed
the
documentation-updates
branch
from
cce3483
to
d702784
Compare
Reformulate a few sentences and code blocks in the documentation so that it is using valid syntax and can be checked accordingly
shym
force-pushed
the
documentation-updates
branch
from
c4c9280
to
4b497e7
Compare
|
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 |
n-osborne
approved these changes
Sep 8, 2023
shym
added
documentation
no-changelog-needed
In the Gospel documentation, maybe it is not useful to state that we are talking about Gospel...
Move the tips to the reference sections where they apply
shym
force-pushed
the
documentation-updates
branch
from
a5ed3bb
to
35fcfaa
Compare
|
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. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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