Separate readme and docs content #8662
Conversation
README.md
Outdated
| Documentation | ||
| === | ||
|
|
||
| Before you jump into the code, review the documentation [Solana: Blockchain Rebuilt for Scale](https://docs.solana.com). | ||
|
|
||
| (The _latest_ development version of the docs is [available here](https://docs.solana.com/v/master).) | ||
|
|
||
| Release Binaries |
There was a problem hiding this comment.
@mvines, do you see the need for any of this to be preserved elsewhere? Seems like a far amount of overlap with the "Install Solana" docs.
| $ NDEBUG=1 ./multinode-demo/bench-tps.sh # runs against localhost by default | ||
| ``` | ||
|
|
||
| What just happened? The client demo spins up several threads to send 500,000 transactions to the testnet as quickly as it can. The client then pings the testnet periodically to see how many transactions it processed in that time. Take note that the demo intentionally floods the network with UDP packets, such that the network will almost certainly drop a bunch of them. This ensures the testnet has an opportunity to reach 710k TPS. The client demo completes after it has convinced itself the testnet won't process any additional transactions. You should see several TPS measurements printed to the screen. In the multinode variation, you'll see TPS measurements for each validator node as well. |
There was a problem hiding this comment.
TODO: Gotta much sure docs like this aren't lost
| You can also attach to a running process with GDB. The leader's process is named _solana-validator_: | ||
|
|
||
| ```bash | ||
| $ sudo gdb |
There was a problem hiding this comment.
TODO: Ensure this is in the readme
|
|
||
| ### Blockstreamer | ||
|
|
||
| Solana supports a node type called a _blockstreamer_. This validator variation is intended for applications that need to observe the data plane without participating in transaction validation or ledger replication. |
There was a problem hiding this comment.
TODO: Find a new place in the docs for this
| @@ -14,6 +14,14 @@ The architecture describes a theoretical upper bound of 710 thousand transaction | |||
|
|
|||
| All claims, content, designs, algorithms, estimates, roadmaps, specifications, and performance measurements described in this project are done with the author's best effort. It is up to the reader to check and validate their accuracy and truthfulness. Furthermore, nothing in this project constitutes a solicitation for investment. | |||
|
|
|||
| ## Why Solana? | |||
There was a problem hiding this comment.
This content was in the readme. Not sure where best to put it. "Why Solana?" doesn't seem quite right. Suggestions?
|
This PR isn't a good starting point. The "Building from Source" page isn't really about building from source. It's about running Bench TPS. While it doesn't belong in its current location, it's not obvious if it belongs in bench-tps/README.md or if perhaps, we should add it to https://docs.solana.com/v/master/cluster/performance-metrics to help make our benchmarks more reproducible. |
Problem
Most of the docs view Solana as a product, a black box. Most of the Github readme views Solana as a Rust open source project. There's a few exceptions for no particularly good reason.
Summary of Changes
Attempt a cleaner separation. Let the README be just enough to get developers up and running. Let the docs be all about how to use the product and how it works.
Thanks @lazaridiscom for the suggestions.