Skip to content

Commit b5c9be3

Browse files
ssflynn77Stephen Flynn
and
Stephen Flynn
authored
all: update links in documentation (ethereum#26882)
Co-authored-by: Stephen Flynn <[email protected]>
1 parent eca3d39 commit b5c9be3

File tree

4 files changed

+11
-11
lines changed

4 files changed

+11
-11
lines changed

Diff for: .github/CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,6 @@ and help.
3535

3636
## Configuration, dependencies, and tests
3737

38-
Please see the [Developers' Guide](https://geth.ethereum.org/docs/developers/devguide)
38+
Please see the [Developers' Guide](https://geth.ethereum.org/docs/developers/geth-developer/dev-guide)
3939
for more details on configuring your environment, managing project dependencies
4040
and testing procedures.

Diff for: README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -36,18 +36,18 @@ directory.
3636

3737
| Command | Description |
3838
| :--------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
39-
| **`geth`** | Our main Ethereum CLI client. It is the entry point into the Ethereum network (main-, test- or private net), capable of running as a full node (default), archive node (retaining all historical state) or a light node (retrieving data live). It can be used by other processes as a gateway into the Ethereum network via JSON RPC endpoints exposed on top of HTTP, WebSocket and/or IPC transports. `geth --help` and the [CLI page](https://geth.ethereum.org/docs/interface/command-line-options) for command line options. |
39+
| **`geth`** | Our main Ethereum CLI client. It is the entry point into the Ethereum network (main-, test- or private net), capable of running as a full node (default), archive node (retaining all historical state) or a light node (retrieving data live). It can be used by other processes as a gateway into the Ethereum network via JSON RPC endpoints exposed on top of HTTP, WebSocket and/or IPC transports. `geth --help` and the [CLI page](https://geth.ethereum.org/docs/fundamentals/command-line-options) for command line options. |
4040
| `clef` | Stand-alone signing tool, which can be used as a backend signer for `geth`. |
4141
| `devp2p` | Utilities to interact with nodes on the networking layer, without running a full blockchain. |
42-
| `abigen` | Source code generator to convert Ethereum contract definitions into easy-to-use, compile-time type-safe Go packages. It operates on plain [Ethereum contract ABIs](https://docs.soliditylang.org/en/develop/abi-spec.html) with expanded functionality if the contract bytecode is also available. However, it also accepts Solidity source files, making development much more streamlined. Please see our [Native DApps](https://geth.ethereum.org/docs/dapp/native-bindings) page for details. |
42+
| `abigen` | Source code generator to convert Ethereum contract definitions into easy-to-use, compile-time type-safe Go packages. It operates on plain [Ethereum contract ABIs](https://docs.soliditylang.org/en/develop/abi-spec.html) with expanded functionality if the contract bytecode is also available. However, it also accepts Solidity source files, making development much more streamlined. Please see our [Native DApps](https://geth.ethereum.org/docs/developers/dapp-developer/native-bindings) page for details. |
4343
| `bootnode` | Stripped down version of our Ethereum client implementation that only takes part in the network node discovery protocol, but does not run any of the higher level application protocols. It can be used as a lightweight bootstrap node to aid in finding peers in private networks. |
4444
| `evm` | Developer utility version of the EVM (Ethereum Virtual Machine) that is capable of running bytecode snippets within a configurable environment and execution mode. Its purpose is to allow isolated, fine-grained debugging of EVM opcodes (e.g. `evm --code 60ff60ff --debug run`). |
4545
| `rlpdump` | Developer utility tool to convert binary RLP ([Recursive Length Prefix](https://ethereum.org/en/developers/docs/data-structures-and-encoding/rlp)) dumps (data encoding used by the Ethereum protocol both network as well as consensus wise) to user-friendlier hierarchical representation (e.g. `rlpdump --hex CE0183FFFFFFC4C304050583616263`). |
4646

4747
## Running `geth`
4848

4949
Going through all the possible command line flags is out of scope here (please consult our
50-
[CLI Wiki page](https://geth.ethereum.org/docs/interface/command-line-options)),
50+
[CLI Wiki page](https://geth.ethereum.org/docs/fundamentals/command-line-options)),
5151
but we've enumerated a few common parameter combos to get you up to speed quickly
5252
on how you can run your own `geth` instance.
5353

@@ -82,10 +82,10 @@ This command will:
8282
* Start `geth` in snap sync mode (default, can be changed with the `--syncmode` flag),
8383
causing it to download more data in exchange for avoiding processing the entire history
8484
of the Ethereum network, which is very CPU intensive.
85-
* Start the built-in interactive [JavaScript console](https://geth.ethereum.org/docs/interface/javascript-console),
85+
* Start the built-in interactive [JavaScript console](https://geth.ethereum.org/docs/interacting-with-geth/javascript-console),
8686
(via the trailing `console` subcommand) through which you can interact using [`web3` methods](https://github.com/ChainSafe/web3.js/blob/0.20.7/DOCUMENTATION.md)
8787
(note: the `web3` version bundled within `geth` is very old, and not up to date with official docs),
88-
as well as `geth`'s own [management APIs](https://geth.ethereum.org/docs/rpc/server).
88+
as well as `geth`'s own [management APIs](https://geth.ethereum.org/docs/interacting-with-geth/rpc).
8989
This tool is optional and if you leave it out you can always attach it to an already running
9090
`geth` instance with `geth attach`.
9191

@@ -175,7 +175,7 @@ accessible from the outside.
175175
As a developer, sooner rather than later you'll want to start interacting with `geth` and the
176176
Ethereum network via your own programs and not manually through the console. To aid
177177
this, `geth` has built-in support for a JSON-RPC based APIs ([standard APIs](https://ethereum.github.io/execution-apis/api-documentation/)
178-
and [`geth` specific APIs](https://geth.ethereum.org/docs/rpc/server)).
178+
and [`geth` specific APIs](https://geth.ethereum.org/docs/interacting-with-geth/rpc)).
179179
These can be exposed via HTTP, WebSockets and IPC (UNIX sockets on UNIX based
180180
platforms, and named pipes on Windows).
181181

Diff for: cmd/checkpoint-admin/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Deploy checkpoint oracle contract. `--signers` indicates the specified trusted s
4646
checkpoint-admin deploy --rpc <NODE_RPC_ENDPOINT> --clef <CLEF_ENDPOINT> --signer <SIGNER_TO_SIGN_TX> --signers <TRUSTED_SIGNER_LIST> --threshold 1
4747
```
4848

49-
It is worth noting that checkpoint-admin only supports clef as a signer for transactions and plain text(checkpoint). For more clef usage, please see the clef [tutorial](https://geth.ethereum.org/docs/clef/tutorial) .
49+
It is worth noting that checkpoint-admin only supports clef as a signer for transactions and plain text(checkpoint). For more clef usage, please see the clef [tutorial](https://geth.ethereum.org/docs/tools/clef/tutorial) .
5050

5151
#### Sign
5252

Diff for: cmd/geth/consolecmd.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ var (
3737
Description: `
3838
The Geth console is an interactive shell for the JavaScript runtime environment
3939
which exposes a node admin interface as well as the Ðapp JavaScript API.
40-
See https://geth.ethereum.org/docs/interface/javascript-console.`,
40+
See https://geth.ethereum.org/docs/interacting-with-geth/javascript-console.`,
4141
}
4242

4343
attachCommand = &cli.Command{
@@ -49,7 +49,7 @@ See https://geth.ethereum.org/docs/interface/javascript-console.`,
4949
Description: `
5050
The Geth console is an interactive shell for the JavaScript runtime environment
5151
which exposes a node admin interface as well as the Ðapp JavaScript API.
52-
See https://geth.ethereum.org/docs/interface/javascript-console.
52+
See https://geth.ethereum.org/docs/interacting-with-geth/javascript-console.
5353
This command allows to open a console on a running geth node.`,
5454
}
5555

@@ -61,7 +61,7 @@ This command allows to open a console on a running geth node.`,
6161
Flags: flags.Merge(nodeFlags, consoleFlags),
6262
Description: `
6363
The JavaScript VM exposes a node admin interface as well as the Ðapp
64-
JavaScript API. See https://geth.ethereum.org/docs/interface/javascript-console`,
64+
JavaScript API. See https://geth.ethereum.org/docs/interacting-with-geth/javascript-console`,
6565
}
6666
)
6767

0 commit comments

Comments
 (0)