docs: update public guides#2185
Conversation
|
cc @igamigo who might be interested in the local network setup. |
|
|
||
| ## Monitoring and Traces | ||
|
|
||
| The local network exports OpenTelemetry traces to Tempo. Grafana is preconfigured with Tempo as a data source, so use |
There was a problem hiding this comment.
| The local network exports OpenTelemetry traces to Tempo. Grafana is preconfigured with Tempo as a data source, so use | |
| The local network exports OpenTelemetry traces to Tempo. Grafana is pre-configured with Tempo as a data source, so use |
There was a problem hiding this comment.
I actually had to triple check this. Turns out both are correct; your suggestion just means you're old is the old school way 😉
| ```text | ||
| Clients, wallets, applications | ||
| | | ||
| Load balancer | ||
| | | ||
| Public RPC full nodes | ||
| | | ||
| Block/proof subscriptions | ||
| | | ||
| Sequencer | ||
| / | \ | ||
| / | \ | ||
| Validator NTX builder Remote batch/block provers | ||
| | | ||
| Remote tx prover | ||
|
|
||
| Network monitor observes RPC, validator, provers, explorer, faucet, and note transport. | ||
| ``` |
There was a problem hiding this comment.
Enabling mermaid would allow us to render a much better diagram with a more maintainable representation here:
| ```text | |
| Clients, wallets, applications | |
| | | |
| Load balancer | |
| | | |
| Public RPC full nodes | |
| | | |
| Block/proof subscriptions | |
| | | |
| Sequencer | |
| / | \ | |
| / | \ | |
| Validator NTX builder Remote batch/block provers | |
| | | |
| Remote tx prover | |
| Network monitor observes RPC, validator, provers, explorer, faucet, and note transport. | |
| ``` | |
| ```mermaid | |
| flowchart TD | |
| A["Clients, wallets, applications"] --> B["Load balancer"] | |
| B --> C["Public RPC full nodes"] | |
| C --> D["Block/proof subscriptions"] | |
| D --> E["Sequencer"] | |
| E --> F["Validator"] | |
| E --> G["NTX builder"] | |
| E --> H["Remote batch/block provers"] | |
| G --> I["Remote tx prover"] |
There was a problem hiding this comment.
We've used excalidraw diagrams in the past for these; mermaid is maintainable but so ugly 🥲
I'll see once I get there.
kkovaacs
left a comment
There was a problem hiding this comment.
Left a few nits and a suggestion but otherwise looks good.
|
I'm going to merge this, and then open a new PR for the network operator guide. Once that's complete, only the internal dev docs need updating but that can wait. |
e6bb9e0 to
6f4b4bf
Compare
This PR revamps the external/public facing docs to the new distributes sequencer/full node configuration.
I have also:
ci.make compose-xtomake local-network-xmake typosonly checks for known typos, not general purpose spellcheckingnpmbased :( but I didn't find much else that's easyI still need to do the network operator guide. It does contain content, but that was AI generated and has not had a pass (or three) done on it. Please ignore that section.
I would suggest reviewing using the actual docusaurus server, and not as raw markdown nor the diffs since this is effectively a full rewrite. Also note that the guides use a
binary/dockertab split.make install-tools cd docs/external npm ci npm run start:devI'll keep pushing changes until the operator guide is complete as well; but this is a large chunk so having reviews come in would be great.