Skip to content

Commit f33de3b

Browse files
authored
feat: update docusaurus, improve styles (#126)
* feat: update docusaurus, improve styles * fix footer link color * fix table of content links
1 parent f2016c0 commit f33de3b

File tree

10 files changed

+739
-2169
lines changed

10 files changed

+739
-2169
lines changed

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ Fluence Docs are built using [Docusaurus 2](https://docusaurus.io/), a modern st
1111
- Please at least use spell checker inside your editor or maybe Grammarly and be attentive when writing docs - they are the face of the company in a sense
1212
- [Here](https://github.com/fluencelabs/docs/blob/9c6e5a257f453b6dbffb856fc236917908e80602/docusaurus.config.js#L61) is where you can add syntax highlight for other programming languages. Use \`\`\`aqua and \`\`\`air for codeblocks in these languages. Use \`\`\`sh for something that you intend to type in a shell. Maybe don't put \$ signs and execution results right inside \`\`\`sh code-blocks for the following reasons: \$ signs and commands output mixed with all of it make it harder to copy and use the code from the docs and also some of the commands output will be changed by us and will have to be maintained in the docs as well which is very inconvenient.
1313
- Headings are not just a stylistic tool but also semantic one. Headings are used to give document a structure which is especially important for page navigation for certain people and also for generating valid quick navigation tree that is displayed on the right side of the docs. So basically the main rule is to not skip heading levels (e.g. don't do #Heading followed immediately by ###Heading - use ##Heading instead)
14-
- For the lack of maintainer, Blog is currently removed from `sidebars.js` but we can add it back. It's still available and working
1514
- For `mermaid` code to work you would currently need to do the following:
1615
````markdown
1716
Some text that you have in your md

blog/2021-09-03-marine-rs-sdk-test-update.md

Lines changed: 0 additions & 41 deletions
This file was deleted.

blog/2021-09-08-aqua-compiler-0.3.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

blog/authors.yml

Lines changed: 0 additions & 17 deletions
This file was deleted.

docs/aqua-book/changelog.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ Aqua compiler's versioning scheme is the following: `0.BREAKING.ENHANCING.RELEAS
1010
### [0.14.7](https://github.com/fluencelabs/aqua/releases/tag/aqua-v0.14.7) - May 14, 2024
1111

1212

13-
* **compiler:** Allow declaring imported functions. See [Functions](./language/expressions/functions.md) and [Headers](./language/header/header.md). ([LNG-357](https://linear.app/fluence/issue/LNG-357)) ([#1127](https://github.com/fluencelabs/aqua/issues/1127))
14-
* **compiler:** Allow declaring imported services and abilities. See [Abilities](./language/abilities.md), [Services](./language/services.md) and [Headers](./language/header/header.md). ([LNG-360](https://linear.app/fluence/issue/LNG-360)) ([#1135](https://github.com/fluencelabs/aqua/issues/1135))
15-
* FIX: **lsp:** Correct go-to-definition in VSCode for used types. See [`use`](./language/header/header.md) and [VSCE](./getting-started/installation/installation.md). ([LNG-345](https://linear.app/fluence/issue/LNG-345)) ([#1128](https://github.com/fluencelabs/aqua/issues/1128))
13+
* **compiler:** Allow declaring imported functions. See [Functions](./language/expressions/functions.md) and [Headers](./language//expressions/header.md). ([LNG-357](https://linear.app/fluence/issue/LNG-357)) ([#1127](https://github.com/fluencelabs/aqua/issues/1127))
14+
* **compiler:** Allow declaring imported services and abilities. See [Abilities](./language/abilities.md), [Services](./language/services.md) and [Headers](./language/expressions/header.md). ([LNG-360](https://linear.app/fluence/issue/LNG-360)) ([#1135](https://github.com/fluencelabs/aqua/issues/1135))
15+
* FIX: **lsp:** Correct go-to-definition in VSCode for used types. See [`use`](./language/expressions/header.md) and [VSCE](./getting-started/installation/installation.md). ([LNG-345](https://linear.app/fluence/issue/LNG-345)) ([#1128](https://github.com/fluencelabs/aqua/issues/1128))
1616
* FIX: **lsp:** Fix OOM in VSCode on big projects. See [VSCE](./getting-started/installation/installation.md). ([#1134](https://github.com/fluencelabs/aqua/issues/1134))
1717

1818
### [0.14.6](https://github.com/fluencelabs/aqua/releases/tag/aqua-v0.14.6) - April 18, 2024
1919

20-
* FIX: **parser**: Allow whitespace after `aqua` header. See [Headers](./language/header/header.md). ([#1112](https://github.com/fluencelabs/aqua/issues/1112))
20+
* FIX: **parser**: Allow whitespace after `aqua` header. See [Headers](./language/expressions/header.md). ([#1112](https://github.com/fluencelabs/aqua/issues/1112))
2121
* FIX: **compiler:** Catch all errors in `?[...]`. See [Collections](./language/values.md#collections). ([LNG-351](https://linear.app/fluence/issue/LNG-351) ([#1114](https://github.com/fluencelabs/aqua/issues/1114))
22-
* FIX: **compiler:** Allow declaring imported symbols. See [Headers](./language/header/header.md). ([LNG-344](https://linear.app/fluence/issue/LNG-344)) ([#1109](https://github.com/fluencelabs/aqua/issues/1109))
22+
* FIX: **compiler:** Allow declaring imported symbols. See [Headers](./language/expressions/header.md). ([LNG-344](https://linear.app/fluence/issue/LNG-344)) ([#1109](https://github.com/fluencelabs/aqua/issues/1109))
2323
* FIX: **compiler:** Refactor header semantics. ([LNG-352](https://linear.app/fluence/issue/LNG-352)) ([#1113](https://github.com/fluencelabs/aqua/issues/1113))
2424
* FIX: **compiler:** Show correct error in VSCode if exported function compiled with error. See [VSCE](./getting-started/installation/installation.md). ([LNG-356](https://linear.app/fluence/issue/LNG-356)) ([#1126](https://github.com/fluencelabs/aqua/issues/1126))
2525
* FIX: **lsp:** Correct go-to-definition for abilities as arguments in functions. See [Abilities](./language/abilities.md) and [VSCE](./getting-started/installation/installation.md). ([LNG-343](https://linear.app/fluence/issue/LNG-343)) ([#1116](https://github.com/fluencelabs/aqua/issues/1116))
@@ -32,7 +32,7 @@ Aqua compiler's versioning scheme is the following: `0.BREAKING.ENHANCING.RELEAS
3232
### [0.14.4](https://github.com/fluencelabs/aqua/releases/tag/aqua-v0.14.4) - March 1, 2024
3333

3434
* FIX: **compiler:** Correctly rename symbols in arrows during inlining. ([LNG-346](https://linear.app/fluence/issue/LNG-346)) ([#1094](https://github.com/fluencelabs/aqua/issues/1094))
35-
* FIX: **compiler:** Fix importing abilities with `use`. See [Abilities](./language/abilities.md) and [Headers](./language/header/header.md). ([LNG-324](https://linear.app/fluence/issue/LNG-324)) ([#1077](https://github.com/fluencelabs/aqua/issues/1077))
35+
* FIX: **compiler:** Fix importing abilities with `use`. See [Abilities](./language/abilities.md) and [Headers](./language/expressions/header.md). ([LNG-324](https://linear.app/fluence/issue/LNG-324)) ([#1077](https://github.com/fluencelabs/aqua/issues/1077))
3636

3737
### [0.14.3](https://github.com/fluencelabs/aqua/releases/tag/aqua-v0.14.3) - February 29, 2024
3838

@@ -52,7 +52,7 @@ Aqua compiler's versioning scheme is the following: `0.BREAKING.ENHANCING.RELEAS
5252

5353
### [0.14.0](https://github.com/fluencelabs/aqua/releases/tag/aqua-v0.14.0) - January 30, 2024
5454

55-
* BREAKING CHANGE: **compiler:** Force `aqua` header for all aqua files. See [Header](./language/header/header.md). ([LNG-308](https://linear.app/fluence/issue/LNG-308)) ([#1028](https://github.com/fluencelabs/aqua/issues/1028))
55+
* BREAKING CHANGE: **compiler:** Force `aqua` header for all aqua files. See [Header](./language/expressions/header.md). ([LNG-308](https://linear.app/fluence/issue/LNG-308)) ([#1028](https://github.com/fluencelabs/aqua/issues/1028))
5656
* FIX: **compiler:** Correctly rename stream captured by closure. See [Streams](./language/crdt-streams.md) and [Closures](./language/closures.md). ([LNG-325](https://linear.app/fluence/issue/LNG-325)) ([#1055](https://github.com/fluencelabs/aqua/issues/1055))
5757
* PERFORMANCE: **compiler:** Optimize `Inliner` ([LNG-322](https://linear.app/fluence/issue/LNG-322)) ([#1047](https://github.com/fluencelabs/aqua/issues/1047))
5858
* PERFORMANCE: **compiler:** Optimize `Linker` ([LNG-321](https://linear.app/fluence/issue/LNG-321)) ([#1049](https://github.com/fluencelabs/aqua/issues/1049))

docs/build/quickstarts/your_first_function.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ To recap, we loaded our myService.wasm module into the REPl, identified our call
181181

182182
In addition to interactive testing with REPL, *cargo-based unit tests* are also available. For more information on creating Marine services, see the [Marine Book](https://fluence.dev/docs/marine-book/introduction).
183183

184-
Now that we are satisfied that our code is in working order, it's time to think about deployment. If you haven't set up your wallet with the necessary test tokens, see [Setting Up](./../setting-up/setting_up.md).
184+
Now that we are satisfied that our code is in working order, it's time to think about deployment. If you haven't set up your wallet with the necessary test tokens, see [Setting Up](../../build/setting-up/setting-up/setting-up.md).
185185

186186
We'll deploy to the `dar` testnet and just to make sure you are set up correctly, run:
187187

docusaurus.config.ts

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,6 @@ const config: Config = {
4545
sidebarPath: require.resolve("./sidebars.js"),
4646
editUrl: "https://github.com/fluencelabs/docs/tree/main",
4747
},
48-
blog: {
49-
showReadingTime: true,
50-
editUrl: "https://github.com/fluencelabs/docs/tree/main",
51-
},
5248
theme: {
5349
customCss: require.resolve("./src/css/custom.scss"),
5450
},
@@ -120,7 +116,6 @@ const config: Config = {
120116
docId: "stake/overview",
121117
label: "Stake",
122118
},
123-
// { to: "/blog", label: "Blog", position: "left" },
124119
{
125120
href: "https://github.com/fluencelabs",
126121
label: "GitHub",
@@ -180,10 +175,6 @@ const config: Config = {
180175
{
181176
title: "More",
182177
items: [
183-
// {
184-
// label: "Blog",
185-
// to: "/blog",
186-
// },
187178
{
188179
label: "GitHub",
189180
href: "https://github.com/fluencelabs",

0 commit comments

Comments
 (0)