diff --git a/website2/documentation/concepts.mdx b/website2/documentation/concepts.mdx index e1f2d01a..f88ce44f 100644 --- a/website2/documentation/concepts.mdx +++ b/website2/documentation/concepts.mdx @@ -17,11 +17,11 @@ of the above entities and give them structure. `Project`s are described at the bottom in the [Projects](#projects) section. All of these concepts are implemented as typescript types. Feel free to browse -the [API docs](https://doc.deno.land/https://garn.io/ts/v0.0.19/mod.ts) as well. +the [API docs](https://doc.deno.land/https://garn.io/ts/v0.0.20/mod.ts) as well. ## Environments -(See also the [API docs](https://doc.deno.land/https://garn.io/ts/v0.0.19/mod.ts/~/Environment).) +(See also the [API docs](https://doc.deno.land/https://garn.io/ts/v0.0.20/mod.ts/~/Environment).) `Environment`s define what is available to a computation. For example they can contain compilers and developer tools that you want to use on a project, but @@ -41,7 +41,7 @@ what the `Environment`s provide. For example `Check`s, which are our next topic. ## Checks -(See also the [API docs](https://doc.deno.land/https://garn.io/ts/v0.0.19/mod.ts/~/Check).) +(See also the [API docs](https://doc.deno.land/https://garn.io/ts/v0.0.20/mod.ts/~/Check).) `Check`s are commands (usually shell commands) that are used to define reproducible, automated tests or other checks. They run in a sandbox, which @@ -64,7 +64,7 @@ configuration. ## Executables -(See also the [API docs](https://doc.deno.land/https://garn.io/ts/v0.0.19/mod.ts/~/Executable).) +(See also the [API docs](https://doc.deno.land/https://garn.io/ts/v0.0.20/mod.ts/~/Executable).) `Executable`s are commands (usually shell snippets) that are being run on your local machine (not in a sandbox). They are based on an underlying `Environment`, @@ -80,7 +80,7 @@ and can make use of e.g. the tools that `Environment`s provide. You can use Here's a small example: ```typescript -import * as garn from "https://garn.io/ts/v0.0.19/mod.ts"; +import * as garn from "https://garn.io/ts/v0.0.20/mod.ts"; export const hello = garn.emptyEnvironment.shell("echo Hello, world!"); @@ -90,7 +90,7 @@ You can run `Executable`s with `garn run`. ## Packages -(See also the [API docs](https://doc.deno.land/https://garn.io/ts/v0.0.19/mod.ts/~/Package).) +(See also the [API docs](https://doc.deno.land/https://garn.io/ts/v0.0.20/mod.ts/~/Package).) `Package`s are instructions to `garn` about how to _build_ a set of files. For example for a Go backend a package would define how to compile it into @@ -106,7 +106,7 @@ You can build `Package`s with `garn build`. ## Projects -(See also the [API docs](https://doc.deno.land/https://garn.io/ts/v0.0.19/mod.ts/~/Project).) +(See also the [API docs](https://doc.deno.land/https://garn.io/ts/v0.0.20/mod.ts/~/Project).) `Project`s are used to combine `Environment`s, `Check`s, `Executable`s and `Package`s into a single entity. A `Project` can contain any number of these @@ -125,8 +125,8 @@ that contains a few `Check`s and adds a developer tool to its default environment: ```typescript -import * as garn from "https://garn.io/ts/v0.0.19/mod.ts"; -import * as pkgs from "https://garn.io/ts/v0.0.19/nixpkgs.ts"; +import * as garn from "https://garn.io/ts/v0.0.20/mod.ts"; +import * as pkgs from "https://garn.io/ts/v0.0.20/nixpkgs.ts"; export const project = garn.javascript .mkNpmProject({ diff --git a/website2/documentation/getting_started.mdx b/website2/documentation/getting_started.mdx index ffdaeeb8..bee32824 100644 --- a/website2/documentation/getting_started.mdx +++ b/website2/documentation/getting_started.mdx @@ -49,7 +49,7 @@ To update garn to a new version you can run: nix profile list # Find the index number of the entry where 'Original flake URL' starts with `github:garnix-io/garn`. nix profile remove -nix profile install github:garnix-io/garn/v0.0.19 +nix profile install github:garnix-io/garn/v0.0.20 ``` ### Manual installation @@ -162,4 +162,4 @@ garn --fish-completion-script (which garn) > ~/.config/fish/completions/garn.fis - [tutorial](/docs/tutorial) - [garn concepts](/docs/concepts) -- [typescript api](https://doc.deno.land/https://garn.io/ts/v0.0.19/mod.ts) +- [typescript api](https://doc.deno.land/https://garn.io/ts/v0.0.20/mod.ts) diff --git a/website2/documentation/tutorial.mdx b/website2/documentation/tutorial.mdx index 9d20a6a8..2bdf254c 100644 --- a/website2/documentation/tutorial.mdx +++ b/website2/documentation/tutorial.mdx @@ -22,8 +22,8 @@ construct projects for common stacks, but you can also define these yourself. Here is an example `garn.ts` file for a single node-based project: ```typescript -import * as garn from "https://garn.io/ts/v0.0.19/mod.ts"; -import * as pkgs from "https://garn.io/ts/v0.0.19/nixpkgs.ts"; +import * as garn from "https://garn.io/ts/v0.0.20/mod.ts"; +import * as pkgs from "https://garn.io/ts/v0.0.20/nixpkgs.ts"; export const frontend = garn.javascript.mkNpmProject({ description: "my frontend", diff --git a/website2/src/components/documentationPage/sidebar/index.tsx b/website2/src/components/documentationPage/sidebar/index.tsx index 80fd4213..738e8b8a 100644 --- a/website2/src/components/documentationPage/sidebar/index.tsx +++ b/website2/src/components/documentationPage/sidebar/index.tsx @@ -28,7 +28,7 @@ export const Sidebar = ({ links, active }: Props) => { ))} Typescript API