.
The local documentation is suboptimal and compiled with pandoc, not
docusaurus so it doesn't understand or process remark-code-import file includes,
diff --git a/doc/md/compatibility.md b/doc/md/compatibility.md
index 7ea32cb2b9b..7de5953a749 100644
--- a/doc/md/compatibility.md
+++ b/doc/md/compatibility.md
@@ -174,21 +174,22 @@ Motoko compiler (`moc`) now supports:
- `moc --stable-compatible ` checks two `.most` files for upgrade compatibility
To upgrade from `cur.wasm` to `nxt.wasm` we need check both Candid interface and stable variables are "compatible"
-
- didc check nxt.did cur.did // nxt <: cur
- moc --stable-compatible cur.most nxt.most // cur <<: nxt
-
+```
+didc check nxt.did cur.did // nxt <: cur
+moc --stable-compatible cur.most nxt.most // cur <<: nxt
+```
E.g. the upgrade from `v2` to `v3` fails this check:
-
- > moc --stable-compatible v2.most v3.most
- (unknown location): Compatibility error [M0170], stable variable state of previous type
- var Int
- cannot be consumed at new type
- var Nat
+```
+> moc --stable-compatible v2.most v3.most
+(unknown location): Compatibility error [M0170], stable variable state of previous type
+ var Int
+cannot be consumed at new type
+ var Nat
+```
## Examples in the wild
-A common, real-world example of an incompatible upgrade can be found on the forum:
+A common, real-world example of an incompatible upgrade can be found on the forum: \
In that example, a user was attempting to add a field to the record payload of an array, by upgrading from stable type interface:
diff --git a/doc/md/upgrades.md b/doc/md/upgrades.md
index 35766398e84..649d2316832 100644
--- a/doc/md/upgrades.md
+++ b/doc/md/upgrades.md
@@ -13,7 +13,7 @@ For applications written in Motoko, the language provides high-level support for
Utilizing stable storage depends on you — as the application programmer — anticipating and indicating the data you want to retain after an upgrade. Depending on the application, the data you decide to persist might be some, all, or none of a given actor’s state.
## Declaring stable variables
@@ -26,7 +26,7 @@ More precisely, every `let` and `var` variable declaration in an actor can speci
Concretely, you use the following syntax to declare stable or flexible variables in an actor:
....
- ::=
+\ ::=
(public|private)? (stable|flexible)? dec
....
-->
@@ -152,7 +152,7 @@ Upgrade safety does not guarantee that the upgrade process will succeed (it can
:::tip
-You can check valid Candid subtyping between two services described in `.did` files, `cur.did` and `nxt.did` (containing Candid types), using the `didc` tool with argument `check nxt.did cur.did`. The `didc` tool is available at .
+You can check valid Candid subtyping between two services described in `.did` files, `cur.did` and `nxt.did` (containing Candid types), using the `didc` tool with argument `check nxt.did cur.did`. The `didc` tool is available at \.
:::
diff --git a/src/Notes.md b/src/Notes.md
index 52f4266824a..a35761d034f 100644
--- a/src/Notes.md
+++ b/src/Notes.md
@@ -2,17 +2,17 @@
- Address TBR and TBD comments in source.
- Why does BinE not take two immediate sub-expressions. Currently it only has one so the parser has to use TupE to create a tuple. A: this is a typo, make it binary.
-- Relational operators (=, <, etc.) are missing - just treat them as binops? Yes, or add another class of bool producing RelE operations
+- Relational operators (=, \<, etc.) are missing - just treat them as binops? Yes, or add another class of bool producing RelE operations
- Lhs of AssignE ast node is too general - these should be *locations* - shall we encode this
in the syntax or as a static check? Preferably as static check - note we should allow array locations and object fields as l-values too. Alternative: introduce second class address ypes, perhaps indexed by location type for type-directed compilation.
-- what syntax do we want for rotation operators - do we want to support JS >>> operator?
- Andreas has seen something like <>> used in other languages.a
+- what syntax do we want for rotation operators - do we want to support JS \>\>\> operator?
+ Andreas has seen something like \<\>\> used in other languages.a
- do we really want async as a firs-class value or should we
syntactically restrict await to async function calls and immediate blocks?
The former supports overlapped io, passing async's as values and the registration of multiple waiters on the same async value.
The second dissallows overlapped calls and allows exactly one waiter to await an async call.
- it looks like we want operator overloading, at least on primitive types. Is that correct? Yes
-- do we want conversion (eg. int32->iny64), both implicit and explicit. No, just use
+- do we want conversion (eg. int32-\>iny64), both implicit and explicit. No, just use
functions for now.
- the parser requires parens around the condition of a while (...) ... and loop ... while (...) constructs. This appears to agree with JS. A: Andreas would like a more principled solution using expression based syntax, while atomic_exp atomic exp should do.
- unary update (++i etc) NYI but should be - not sure about postfix variants
diff --git a/test/README.md b/test/README.md
index 4b7cac3267b..58797b4fdfe 100644
--- a/test/README.md
+++ b/test/README.md
@@ -137,7 +137,7 @@ See `README.md` in the `random/` subdirectory.
Performance regression testing
------------------------------
-The purpose of the `perf/` directory is to have a small (<20) set of test
+The purpose of the `perf/` directory is to have a small (\<20) set of test
programs representative of real use of Motoko.
For these tests the test suite records the following numbers: