diff --git a/docs-api/docs/intro.md b/docs-api/docs/intro.md index 30dc7c9ab..00429b5c0 100644 --- a/docs-api/docs/intro.md +++ b/docs-api/docs/intro.md @@ -1,4 +1,3 @@ - # Introduction 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 ## Contributing -We welcome contributions to improve this documentation. Please see our [Contributors Guide](/contributors-guide) guide for more information on how to contribute. +We welcome contributions to improve this documentation. Please see our [Contributors Guide](./contributors-guide) guide for more information on how to contribute. diff --git a/docs-api/docs/quickstart.md b/docs-api/docs/quickstart.md index 945ba004f..5e9b52c15 100644 --- a/docs-api/docs/quickstart.md +++ b/docs-api/docs/quickstart.md @@ -22,6 +22,7 @@ specification and the JSON schema [specification][json-schema] to get started. ### Updating the specs #### Compiling + The specification is split into multiple files to improve readability. The spec can be compiled into a single document as follows: @@ -37,14 +38,14 @@ will have all schema `#ref`s resolved. #### Building the docs Once you've updated something in the spec, you can use the docs generation tools -to view the updated specs locally. +to view the updated specs locally. ```console $ npm run build:docs $ npm run watch ``` -The `watch` command starts a local webserver serving the docs in-browser at +The `watch` command starts a local webserver serving the docs in-browser at `http://0.0.0.0:8000` and it rebuilds when you update something in the specs. Please reload the page to see your changes. @@ -54,6 +55,7 @@ There are several mechanisms for testing specification contributions and client conformance. #### Linting + First is the [OpenRPC validator][validator]. It performs some basic syntactic checks on the generated specification. @@ -64,12 +66,13 @@ OpenRPC spec validated successfully. ``` #### Spec tests + Next is `speccheck`. This tool validates the test cases in the `tests` -directory against the specification. There are two npm scripts to simplify this. +directory against the specification. There are two npm scripts to simplify this. ```console $ npm run build:test -$ npm run test +$ npm run test all passing. ``` @@ -81,7 +84,7 @@ $ speccheck -v ``` If you get an error that says: `speccheck: command not found`, - make sure that the go binary is in your $PATH: +make sure that the go binary is in your $PATH: ```console $ export PATH=$HOME/go/bin:$PATH @@ -102,6 +105,7 @@ pyspelling is a wrapper around either [Aspell](http://aspell.net/) or one of those before running `pyspelling`. #### Hive tests + Finally, the test cases in the `tests/` directory may be run against individual execution client using the [`hive`][hive] simulator [`rpc-compat`][rpc-compat]. Please see the documentation in the aforementioned repositories for more @@ -133,15 +137,14 @@ $ npm run graphql:validate This repository is licensed under [CC0][license]. - [playground]: https://ethereum.github.io/execution-apis/api-documentation/ [openrpc]: https://open-rpc.org [validator]: https://open-rpc.github.io/schema-utils-js/functions/validateOpenRPCDocument.html [graphql-schema]: http://graphql-schema.ethdevops.io/?url=https://raw.githubusercontent.com/ethereum/execution-apis/main/graphql.json [eip-1767]: https://eips.ethereum.org/EIPS/eip-1767 -[contributors-guide]: ../contributors-guide +[contributors-guide]: ./contributors-guide [json-schema]: https://json-schema.org [hive]: https://github.com/ethereum/hive [rpc-compat]: https://github.com/ethereum/hive/tree/master/simulators/ethereum/rpc-compat -[test-gen]: ../tests +[test-gen]: ./tests [license]: https://github.com/ethereum/execution-apis/blob/main/LICENSE diff --git a/docusaurus.config.ts b/docusaurus.config.ts index d290c0e07..3f0a05c33 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -10,7 +10,7 @@ const config: Config = { /*future: { v4: true },*/ /* TODO replace url: 'https://ethereum.github.io', */ - url: 'https://zcstarr.github.io', + url: 'https://open-rpc.github.io', baseUrl: '/execution-apis/', organizationName: 'ethereum',