Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
kevinmichaelchen committed Jan 22, 2024
1 parent b06ba35 commit d9b393c
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 6 deletions.
2 changes: 1 addition & 1 deletion buf.gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ plugins:
- paths=source_relative
- require_unimplemented_servers=false
# https://github.com/bufbuild/plugins/tree/main/plugins/bufbuild/validate-go
- plugin: buf.build/bufbuild/validate-go:v1.0.2
- plugin: buf.build/bufbuild/validate-go:v1.0.4
out: internal/idl
opt:
- paths=source_relative
Expand Down
4 changes: 4 additions & 0 deletions docs/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,10 @@ export default defineConfig({
},
],
},
{
label: "Running Locally",
link: "/running-locally/",
},
],
}),
],
Expand Down
8 changes: 3 additions & 5 deletions docs/src/content/docs/running-locally.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,11 @@ title: Running Locally
description: How to run locally
---

Once you've installed [pkgx][pkgx], you'll be able to run everything with one command.
Just run `make`.

[pkgx]: https://pkgx.sh/
It will prompt you to install [pkgx][pkgx].

```shell
make
```
[pkgx]: https://pkgx.sh/

A GraphQL Playground should automatically open for you, where you can start running queries and mutations described in our [API documentation][api-docs].

Expand Down

0 comments on commit d9b393c

Please sign in to comment.