Setup docs template #28

corwintines · 2022-11-14T05:05:14Z

Setup [...slug].tsx for docs template
Moved all docs markdown from /src/pages/docs to /docs in the root folder

netlify · 2022-11-14T05:05:20Z

✅ Deploy Preview for melodious-puffpuff-8e1109 ready!

Name	Link
🔨 Latest commit	`5c949d0`
🔍 Latest deploy log	https://app.netlify.com/sites/melodious-puffpuff-8e1109/deploys/637690a0969c8d00081c299e
😎 Deploy Preview	https://deploy-preview-28--melodious-puffpuff-8e1109.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

nhsz

LGTM, found some broken links and image paths that should be fixed

nhsz · 2022-11-17T20:03:58Z

docs/interacting-with-geth/rpc/ns-debug.md

@@ -631,7 +631,7 @@ Returns the structured logs created during the execution of EVM between two bloc

 `const res = provider.send('debug_subscribe', ['traceChain', '0x3f3a2a', '0x3f3a2b'])`

-please refer to the [subscription page](https://geth.ethereum.org/docs/rpc/pubsub) for more details.
+please refer to the [subscription page](/docs/rpc/pubsub) for more details.


broken link

nhsz · 2022-11-17T20:07:29Z

docs/interacting-with-geth/rpc/ns-eth.md

@@ -7,7 +7,7 @@ Documentation for the API methods in the `eth` namespace can be found on [ethere

 ### eth_subscribe, eth_unsubscribe

-These methods are used for real-time events through subscriptions. See the [subscription documentation](/content/docs/interacting_with_geth/RPC/pubsub.md) for more information.
+These methods are used for real-time events through subscriptions. See the [subscription documentation](/docs/interacting_with_geth/RPC/pubsub) for more information.


broken link

nhsz · 2022-11-17T20:07:52Z

docs/interacting-with-geth/rpc/ns-eth.md

@@ -19,7 +19,7 @@ The method takes 3 parameters: an unsigned transaction object to execute in read

 ##### 1. `Object` - Transaction call object

-The _transaction call object_ is mandatory. Please see [here](/content/docs/interacting_with_geth/RPC/objects.md) for details.
+The _transaction call object_ is mandatory. Please see [here](/docs/interacting_with_geth/RPC/objects) for details.


broken link

nhsz · 2022-11-17T20:08:22Z

docs/interacting-with-geth/rpc/ns-personal.md

@@ -209,7 +209,7 @@ See ecRecover to verify the signature.

 ## personal_signTransaction

-SignTransaction will create a transaction from the given arguments and tries to sign it with the key associated with `tx.from`. If the given passwd isn't able to decrypt the key it fails. The transaction is returned in RLP-form, not broadcast to other nodes. The first argument is a [transaction object](/content/docs/interacting_with_geth/RPC/objects.md) and the second argument is the password, similar to `personal_sendTransaction`.
+SignTransaction will create a transaction from the given arguments and tries to sign it with the key associated with `tx.from`. If the given passwd isn't able to decrypt the key it fails. The transaction is returned in RLP-form, not broadcast to other nodes. The first argument is a [transaction object](/docs/interacting_with_geth/RPC/objects) and the second argument is the password, similar to `personal_sendTransaction`.


broken link

nhsz · 2022-11-17T20:12:08Z

docs/tools/clef/rules.md

@@ -25,7 +25,7 @@ The ruleset engine acts as a gatekeeper to the command line interface - it auto-

 ![Clef ruleset logic](/images/docs/clef_ruleset.png)


broken image path

nhsz · 2022-11-17T20:41:43Z

docs/getting-started/index.md

@@ -300,5 +300,5 @@ It is possible to send transactions using raw curl requests too, but this requir
 ## Summary

 This tutorial has demonstrated how to generate accounts using Geth's built-in account management tool, fund them with testnet ether and use those accounts to interact with Ethereum (Goerli) through a Geth node. Checking account balances, sending transactions and retrieving transaction details were explained using
-the web3.js library via the Geth console and using the JSON-RPC directly using Curl. Note that this is an entry-level tutorial designed to help users get familiar with basic Geth processes, we strongly recommend following this with the [Geth with Clef](/content/docs/getting-started/geth_with_clef) tutorial which will help to
+the web3.js library via the Geth console and using the JSON-RPC directly using Curl. Note that this is an entry-level tutorial designed to help users get familiar with basic Geth processes, we strongly recommend following this with the [Geth with Clef](/docs/getting-started/geth_with_clef) tutorial which will help to


broken link

nhsz · 2022-11-17T21:04:21Z

docs/interacting-with-geth/rpc/graphql.md

@@ -3,7 +3,7 @@ title: GraphQL Server
 description: Documentation for Geth's GraphQL API
 ---

-In addition to the [JSON-RPC APIs](/content/docs/interacting_with_geth/RPC/server.md), Geth supports the GraphQL API as specified by [EIP-1767](https://eips.ethereum.org/EIPS/eip-1767). GraphQL lets you specify which fields of an objects you need as part of the query, eliminating the extra load on the client for filling in fields which are not needed. It also allows for combining several traditional JSON-RPC requests into one query which translates into less overhead and more performance.
+In addition to the [JSON-RPC APIs](/docs/interacting_with_geth/RPC/server), Geth supports the GraphQL API as specified by [EIP-1767](https://eips.ethereum.org/EIPS/eip-1767). GraphQL lets you specify which fields of an objects you need as part of the query, eliminating the extra load on the client for filling in fields which are not needed. It also allows for combining several traditional JSON-RPC requests into one query which translates into less overhead and more performance.


broken link

nhsz · 2022-11-17T21:05:02Z

docs/interacting-with-geth/rpc/index.md

@@ -60,7 +60,7 @@ The `--http.corsdomain` command also acceptsd wildcards that enable access to th

 Websocket is a bidirectional transport protocol. A Websocket connection is maintained by client and server until it is explicitly terminated by one. Most modern browsers support Websocket which means it has good tooling.

-Because Websocket is bidirectional, servers can push events to clients. That makes Websocket a good choice for use-cases involving [event subscription](https://geth.ethereum.org/docs/rpc/pubsub). Another benefit of Websocket is that after the handshake procedure, the overhead of individual messages is low,
+Because Websocket is bidirectional, servers can push events to clients. That makes Websocket a good choice for use-cases involving [event subscription](/docs/rpc/pubsub). Another benefit of Websocket is that after the handshake procedure, the overhead of individual messages is low,


broken link

nhsz · 2022-11-17T21:05:27Z

docs/interacting-with-geth/rpc/index.md

@@ -116,7 +116,7 @@ to subscribe to events. HTTP is a familiar and idempotent transport that closes

 ## Engine-API

-The Engine-API is a set of RPC methods that enable communication between Geth and the [consensus client](/docs/getting_started/consensus-clients.md). These are not designed to be exposed to the user - instead they are called automatically by the clients when they need to exchange information. The Engine API is enabled by default - the user is not required to pass any instruction to Geth to enable these methods.
+The Engine-API is a set of RPC methods that enable communication between Geth and the [consensus client](/docs/getting_started/consensus-clients). These are not designed to be exposed to the user - instead they are called automatically by the clients when they need to exchange information. The Engine API is enabled by default - the user is not required to pass any instruction to Geth to enable these methods.


broken link

nhsz · 2022-11-17T21:18:27Z

docs/tools/clef/tutorial.md

@@ -568,7 +568,7 @@ cat ~/.clef/02f90c0603f4f2f60188/config.json
 This tutorial has bounced back and forth between demonstrating Clef as a standalone tool by making 'manual` JSON RPC requests from the terminal and integrating it as a backend singer for Geth. Using Clef for account management is considered best practise for Geth users because of the additional
 security benefits it offers over and above what it offered by Geth's built-in accounts module. Clef is far more flexible and composable than Geth's built-in account management tool and can interface directly with hardware wallets, while Apps and wallets can request signatures directly from Clef.

-Ultimately, the goal is to deprecate Geth's account management tools completely and replace them with Clef. Until then, users are simply encouraged to choose to use Clef as an optional backend signer for Geth. In addition to the examples on this page, the [Getting started tutorial](/docs/_getting-started/index.md) also demonstrates Clef/Geth integration.
+Ultimately, the goal is to deprecate Geth's account management tools completely and replace them with Clef. Until then, users are simply encouraged to choose to use Clef as an optional backend signer for Geth. In addition to the examples on this page, the [Getting started tutorial](/docs/_getting-started/index) also demonstrates Clef/Geth integration.


broken link

setup template to render for docs

10a0a36

corwintines added 10 commits November 13, 2022 22:18

add "@types/js-yaml": "^4.0.5"

67396c8

test

2ccb3e5

test

f46bdc3

fix build issues

14900bc

add main

d096d10

Merge branch 'master' into setupDocs

71ce846

Merge branch 'master' into setupDocs

d39c1fd

Merge branch 'master' into setupDocs

7c36904

Merge branch 'master' into setupDocs

ee03bd3

fix a bunch of paths

5c949d0

nhsz reviewed Nov 17, 2022

View reviewed changes

corwintines mentioned this pull request Nov 17, 2022

Fix broken paths #36

Closed

nhsz merged commit e1e2043 into master Nov 17, 2022

corwintines deleted the setupDocs branch November 17, 2022 21:43

corwintines mentioned this pull request Nov 22, 2022

Code snippet #33

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Setup docs template #28

Setup docs template #28

corwintines commented Nov 14, 2022

netlify bot commented Nov 14, 2022 •

edited

Loading

nhsz left a comment

nhsz Nov 17, 2022

nhsz Nov 17, 2022

nhsz Nov 17, 2022

nhsz Nov 17, 2022

nhsz Nov 17, 2022

nhsz Nov 17, 2022

nhsz Nov 17, 2022

nhsz Nov 17, 2022

nhsz Nov 17, 2022

nhsz Nov 17, 2022

		@@ -25,7 +25,7 @@ The ruleset engine acts as a gatekeeper to the command line interface - it auto-

		![Clef ruleset logic](/images/docs/clef_ruleset.png)

Setup docs template #28

Setup docs template #28

Conversation

corwintines commented Nov 14, 2022

netlify bot commented Nov 14, 2022 • edited Loading

✅ Deploy Preview for melodious-puffpuff-8e1109 ready!

nhsz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

netlify bot commented Nov 14, 2022 •

edited

Loading