Improve website documentation#103
Conversation
- Improve links & fix dead links - Improve formatting - Improve code snippets (formatting & code) - Fix typos - Consistently use Docusaurus Admonitions for notes
| * system clock | ||
| * random number generation | ||
| * basic reading and writing of files (through use of a [virtual file system](https://github.com/google/jimfs)) | ||
| * basic reading and writing of files (through use of a virtual file system) |
There was a problem hiding this comment.
Removed this link; Jimfs is only one variant of it, and there are already links to Jimfs and ZeroFs on this page.
| Often, this is the way you communicate with basic WASI-enabled modules by way of the [command pattern](https://endive.run/historical-blog/wasi-command-reactor). | ||
| Often, this is the way you communicate with basic WASI-enabled modules by way of the [command pattern](https://dylibso.com/blog/wasi-command-reactor/). |
There was a problem hiding this comment.
Old link was a dead link.
| For instance, in the case of stdout, you would write: | ||
| For instance, you would write: |
There was a problem hiding this comment.
The example actually redirects also stderr and stdin, not only stdout.
| var wasi = WasiOptions.builder().withEnvironment("ENV_ONE_KEY", "my-one-key-value").withEnvironment("ENV_TWO_KEY", "my-two-key-value").build(); | ||
| var wasi = WasiOptions.builder() | ||
| .withEnvironment("ENV_ONE_KEY", "my-one-key-value") | ||
| .withEnvironment("ENV_TWO_KEY", "my-two-key-value") | ||
| .build(); |
There was a problem hiding this comment.
Wrapped this because the line was cut off / required a scrollbar to be readable.
|
CI is failing, for example with: I had assumed the placement of the Should I just revert these changes for now then? Side note: It seems in recent jbang versions (e.g. version 0.141.0, due to jbangdev/jbang#2592?) this can be worked around now by adding:
jbang concatenates all code blocks, and detects the |
andreaTP
left a comment
There was a problem hiding this comment.
This is very very much welcome @Marcono1234 thanks a lot for doing a full pass with fresh eyes on the docs!
I'll merge as soon as the CI is green, however you want to fix it (with or without main) no strong opinions there.
I hope the changes are rather uncontroversial, but please let me know if you want anything changed or reverted.
I have also added some comments below explaining the rationale.