Skip to content

Commit d4fd2ae

Browse files
committed
website: minor improvements and add search
1 parent d46da59 commit d4fd2ae

File tree

4 files changed

+11
-18
lines changed

4 files changed

+11
-18
lines changed

website/docs/heyvl/README.md

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,24 +9,10 @@ The main innovation is that it supports _quantitative_ reasoning via its constru
99
Refer to our [publications](../publications.md) for details on the theory.
1010

1111
A HeyVL file consists of a sequence of declarations: [procedure](./procs.md) and [domain declarations](./domains.md).
12+
Refer to those for more information.
1213

1314
```mdx-code-block
1415
import DocCardList from '@theme/DocCardList';
1516
1617
<DocCardList />
1718
```
18-
19-
## Use the source, Luke
20-
21-
We do not formally describe the syntax of HeyVL in this documentation.
22-
You can find a more formal definition in the [`src/front/parser/grammar.lalrpop`](https://github.com/moves-rwth/caesar/blob/main/src/front/parser/grammar.lalrpop) file that specifies the syntax used to generate Caesar's parser.
23-
It is written in the [LALRPOP language](https://lalrpop.github.io/lalrpop/tutorial/index.html).
24-
25-
## Examples
26-
27-
The [`pgcl/examples-heyvl`](https://github.com/moves-rwth/caesar/tree/main/pgcl/examples-heyvl) directory contains the machine-translated HeyVL code for our pGCL examples.
28-
Note that they are just sequences of HeyVL statements without wrapping procedure declarations.
29-
Refer to the page on the [pGCL frontend](../pgcl.md) for more information.
30-
31-
Caesar's integration tests in [`tests/`](https://github.com/moves-rwth/caesar/tree/main/tests) can also serve as a reference.
32-
Refer to the [development guide](../devguide.md#caesar) for more information about these tests.

website/docs/heyvl/procs.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,9 @@ Let us decompose the example into its parts:
4848
3. We have one **output parameter** `x` of type [`UInt`](../stdlib/numbers.md#uint).
4949
- There may be multiple parameters (input and output), which can be separated by commas (e.g. `init_x: UInt, init_y: UInt`).
5050
4. The `pre` declares the **pre-expectation** `init_x + 0.5`. It is evaluated in the *initial state* (when calling the proc). This is why it is called "pre" (= before running the proc).
51+
- The `pre` is an expression of type [`EUReal`](../stdlib/numbers.md#eureal) over the input parameters.
5152
5. The `post` is the **post-expectation** `x` and evaluated in the final states of the proc (post = after running the proc). We always compare its expected value against the pre.
53+
- The `post` is an expression of type [`EUReal`](../stdlib/numbers.md#eureal) over the input and output parameters.
5254
6. The **body of the proc** assigns `init_x` to `x`. We then do a [probabilistic coin flip](../stdlib/distributions.md#symbolic-with-probabilities) and assign `true` to `prob_choice` with probability `0.5` (and `false` with probability `0.5`). It determines the expected value ($\mathbb{E}$) we look at.
5355
- See [documentation on statements](./statements.md) for more information.
5456
- [The body is optional](#procs-without-body).

website/docusaurus.config.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,11 @@ const config = {
173173
darkTheme: prismThemes.nightOwl,
174174
additionalLanguages: ['bash', 'shell-session'],
175175
},
176+
algolia: {
177+
appId: 'Q93W1TPDIE',
178+
apiKey: '8dc15a6ca0d7a01e9f7ab673468d63a1',
179+
indexName: 'caesarverifier',
180+
}
176181
}),
177182
};
178183

website/src/css/custom.css

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,15 +41,15 @@
4141
}
4242

4343
/* Link decorations */
44-
p a, .markdown ul a {
44+
.markdown p a, .markdown ul a {
4545
--ifm-link-decoration: underline;
4646
}
4747

48-
p a:hover, .markdown ul a:hover {
48+
.markdown p a:hover, .markdown ul a:hover {
4949
text-decoration: none;
5050
}
5151

52-
a.button {
52+
.markdown a.button {
5353
text-decoration: none;
5454
}
5555

0 commit comments

Comments
 (0)