Skip to content

Commit 829c76d

Browse files
authored
Merge pull request #2 from open-rpc/feat/website
chore: update the temporary github pages url to open-rpc
2 parents 73f91ff + 91a6b92 commit 829c76d

File tree

3 files changed

+13
-11
lines changed

3 files changed

+13
-11
lines changed

docs-api/docs/intro.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
# Introduction
32

43
Welcome to the Ethereum JSON-RPC documentation. This site provides comprehensive information about the JSON-RPC APIs provided by Ethereum execution clients.
@@ -36,4 +35,4 @@ Each category serves specific purposes and provides different functionalities fo
3635

3736
## Contributing
3837

39-
We welcome contributions to improve this documentation. Please see our [Contributors Guide](/contributors-guide) guide for more information on how to contribute.
38+
We welcome contributions to improve this documentation. Please see our [Contributors Guide](./contributors-guide) guide for more information on how to contribute.

docs-api/docs/quickstart.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ specification and the JSON schema [specification][json-schema] to get started.
2222
### Updating the specs
2323

2424
#### Compiling
25+
2526
The specification is split into multiple files to improve readability. The
2627
spec can be compiled into a single document as follows:
2728

@@ -37,14 +38,14 @@ will have all schema `#ref`s resolved.
3738
#### Building the docs
3839

3940
Once you've updated something in the spec, you can use the docs generation tools
40-
to view the updated specs locally.
41+
to view the updated specs locally.
4142

4243
```console
4344
$ npm run build:docs
4445
$ npm run watch
4546
```
4647

47-
The `watch` command starts a local webserver serving the docs in-browser at
48+
The `watch` command starts a local webserver serving the docs in-browser at
4849
`http://0.0.0.0:8000` and it rebuilds when you update something in the specs.
4950
Please reload the page to see your changes.
5051

@@ -54,6 +55,7 @@ There are several mechanisms for testing specification contributions and client
5455
conformance.
5556

5657
#### Linting
58+
5759
First is the [OpenRPC validator][validator]. It performs some basic syntactic
5860
checks on the generated specification.
5961

@@ -64,12 +66,13 @@ OpenRPC spec validated successfully.
6466
```
6567

6668
#### Spec tests
69+
6770
Next is `speccheck`. This tool validates the test cases in the `tests`
68-
directory against the specification. There are two npm scripts to simplify this.
71+
directory against the specification. There are two npm scripts to simplify this.
6972

7073
```console
7174
$ npm run build:test
72-
$ npm run test
75+
$ npm run test
7376
all passing.
7477
```
7578

@@ -81,7 +84,7 @@ $ speccheck -v
8184
```
8285

8386
If you get an error that says: `speccheck: command not found`,
84-
make sure that the go binary is in your $PATH:
87+
make sure that the go binary is in your $PATH:
8588

8689
```console
8790
$ export PATH=$HOME/go/bin:$PATH
@@ -102,6 +105,7 @@ pyspelling is a wrapper around either [Aspell](http://aspell.net/) or
102105
one of those before running `pyspelling`.
103106

104107
#### Hive tests
108+
105109
Finally, the test cases in the `tests/` directory may be run against individual
106110
execution client using the [`hive`][hive] simulator [`rpc-compat`][rpc-compat].
107111
Please see the documentation in the aforementioned repositories for more
@@ -133,15 +137,14 @@ $ npm run graphql:validate
133137

134138
This repository is licensed under [CC0][license].
135139

136-
137140
[playground]: https://ethereum.github.io/execution-apis/api-documentation/
138141
[openrpc]: https://open-rpc.org
139142
[validator]: https://open-rpc.github.io/schema-utils-js/functions/validateOpenRPCDocument.html
140143
[graphql-schema]: http://graphql-schema.ethdevops.io/?url=https://raw.githubusercontent.com/ethereum/execution-apis/main/graphql.json
141144
[eip-1767]: https://eips.ethereum.org/EIPS/eip-1767
142-
[contributors-guide]: ../contributors-guide
145+
[contributors-guide]: ./contributors-guide
143146
[json-schema]: https://json-schema.org
144147
[hive]: https://github.com/ethereum/hive
145148
[rpc-compat]: https://github.com/ethereum/hive/tree/master/simulators/ethereum/rpc-compat
146-
[test-gen]: ../tests
149+
[test-gen]: ./tests
147150
[license]: https://github.com/ethereum/execution-apis/blob/main/LICENSE

docusaurus.config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ const config: Config = {
1010
/*future: { v4: true },*/
1111

1212
/* TODO replace url: 'https://ethereum.github.io', */
13-
url: 'https://zcstarr.github.io',
13+
url: 'https://open-rpc.github.io',
1414
baseUrl: '/execution-apis/',
1515

1616
organizationName: 'ethereum',

0 commit comments

Comments
 (0)