Skip to content

Commit

Permalink
feat: docs linter improvements (gnolang#2404)
Browse files Browse the repository at this point in the history
<!-- please provide a detailed description of the changes made in this
pull request. -->

## Description

This PR improves the recently merged docs linter. It adds checks for
improperly escaped JSX tags, and makes the addition of further linter
checks easier with better pipelining.

It also implements a change to the gnoclient docs by introducing godoc,
as well as a few minor fixes.


<details><summary>Contributors' checklist...</summary>

- [x] Added new tests, or not needed, or not feasible
- [x] Provided an example (e.g. screenshot) to aid review or the PR is
self-explanatory
- [x] Updated the official documentation or not needed
- [x] No breaking changes were made, or a `BREAKING CHANGE: xxx` message
was included in the description
- [x] Added references to related issues and PRs
- [x] Provided any useful hints for running manual tests
- [x] Added new benchmarks to [generated
graphs](https://gnoland.github.io/benchmarks), if any. More info
[here](https://github.com/gnolang/gno/blob/master/.benchmarks/README.md).
</details>
  • Loading branch information
leohhhn authored and gfanton committed Jul 23, 2024
1 parent 525d166 commit 2482540
Show file tree
Hide file tree
Showing 14 changed files with 321 additions and 450 deletions.
2 changes: 2 additions & 0 deletions docs/concepts/proof-of-contribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ Presentation: https://github.com/gnolang/workshops/tree/main/presentations/2023-

## High-level schema

```
____ ____ ____ __ _ __ __ _
/ __ \_________ ____ / __/ ____ / __/ _________ ____ / /______(_) /_ __ __/ /_(_)___ ____ _____
/ /_/ / ___/ __ \/ __ \/ /_ / __ \/ /_ / ___/ __ \/ __ \/ __/ ___/ / __ \/ / / / __/ / __ \/ __ \/ ___/
Expand Down Expand Up @@ -55,6 +56,7 @@ Presentation: https://github.com/gnolang/workshops/tree/main/presentations/2023-
^ |
| |
+---------------user TXs can publish and call contracts--------------------+
```

## Components

Expand Down
38 changes: 19 additions & 19 deletions docs/gno-tooling/cli/gnodev.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ Gnodev allows for quick and efficient development of Gno code.

By watching your development directory, gnodev detects changes in your Gno
code, reflecting them in the state of the node immediately. Gnodev also runs a
local instance of `gnoweb`, allowing you to see the rendering of your Gno code instantly.
local instance of `gnoweb`, allowing you to see the rendering of your Gno code instantly.

## Features
- **In-Memory Node**: Gnodev starts an in-memory node, and automatically loads
the **examples** folder and any user-specified paths.
- **Web Interface Server**: Gnodev automatically starts a `gnoweb` server on
[`localhost:8888`](https://localhost:8888).
[`localhost:8888`](https://localhost:8888).
- **Balances and Keybase Customization**: Users can set account balances, load them from a file, or add new
accounts via a flag.
- **Hot Reload**: Gnodev monitors the **examples** folder, as well as any folder specified as an argument for
Expand Down Expand Up @@ -120,20 +120,20 @@ While `gnodev` is running, the following shortcuts are available:

### Options

| Flag | Effect |
|---------------------|---------------------------------------------------------------------|
| --minimal | Start `gnodev` without loading the examples folder. |
| --no-watch | Disable hot reload. |
| --add-account | Pre-add account(s) in the form `<bech32>[=<amount>]` |
| --balances-file | Load a balance for the user(s) from a balance file. |
| --chain-id | Set node ChainID |
| --deploy-key | Default key name or Bech32 address for uploading packages. |
| --home | Set the path to load user's Keybase. |
| --max-gas | Set the maximum gas per block |
| --no-replay | Do not replay previous transactions upon reload |
| --node-rpc-listener | listening address for GnoLand RPC node |
| --root | gno root directory |
| --server-mode | disable interaction, and adjust logging for server use. |
| --verbose | enable verbose output for development |
| --web-listener | web server listening address |
| --web-help-remote | web server help page's remote addr - default to <node-rpc-listener> |
| Flag | Effect |
|---------------------|-----------------------------------------------------------------------|
| --minimal | Start `gnodev` without loading the examples folder. |
| --no-watch | Disable hot reload. |
| --add-account | Pre-add account(s) in the form `<bech32>[=<amount>]` |
| --balances-file | Load a balance for the user(s) from a balance file. |
| --chain-id | Set node ChainID |
| --deploy-key | Default key name or Bech32 address for uploading packages. |
| --home | Set the path to load user's Keybase. |
| --max-gas | Set the maximum gas per block |
| --no-replay | Do not replay previous transactions upon reload |
| --node-rpc-listener | listening address for GnoLand RPC node |
| --root | gno root directory |
| --server-mode | disable interaction, and adjust logging for server use. |
| --verbose | enable verbose output for development |
| --web-listener | web server listening address |
| --web-help-remote | web server help page's remote addr - defaults to <node-rpc-listener\> |
2 changes: 1 addition & 1 deletion docs/reference/gno-js-client/gno-provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Fetches public facing function signatures
* `height` **number** the height for querying.
If omitted, the latest height is used (optional, default `0`)

Returns **Promise<FunctionSignature[]>**
Returns **Promise<FunctionSignature[]\>**

#### Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/gno-js-client/gno-wallet.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Deploys the specified package / realm
#### Parameters

* `gnoPackage` **MemPackage** the package / realm to be deployed
* `funds` **Map<string, number>** the denomination -> value map for funds
* `funds` **Map<string, number\>** the denomination -> value map for funds
* `fee` **TxFee** the custom transaction fee, if any

Returns **Promise<string\>**
Expand Down
192 changes: 0 additions & 192 deletions docs/reference/gnoclient/client.md

This file was deleted.

11 changes: 10 additions & 1 deletion docs/reference/gnoclient/gnoclient.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,13 @@ your Go code
To add Gnoclient to your Go project, run the following command:
```bash
go get github.com/gnolang/gno/gno.land/pkg/gnoclient
```
```

## Reference documentation & usage

To see the full reference documentation for the `gnoclient` package, we recommend
visiting the [`gnoclient godoc page`](https://gnolang.github.io/gno/github.com/gnolang/gno@v0.0.0/gno.land/pkg/gnoclient.html).

For a tutorial on how to use the `gnoclient` package, check out
["How to connect a Go app to Gno.land"](../../how-to-guides/connecting-from-go.md.)

86 changes: 0 additions & 86 deletions docs/reference/gnoclient/signer.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/reference/network-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ id: network-config
| Portal Loop | https://rpc.gno.land:443 | `portal-loop` |
| Testnet 4 | upcoming | upcoming |
| Testnet 3 | https://rpc.test3.gno.land:443 | `test3` |
| Staging | http://rpc.staging.gno.land:26657 | `staging` |
| Staging | http://rpc.staging.gno.land:36657 | `staging` |

### WebSocket endpoints
All networks follow the same pattern for websocket connections:
Expand Down
Loading

0 comments on commit 2482540

Please sign in to comment.