blockworks-foundation
/
solana-with-rpc-optimizations
mirror of https://github.com/blockworks-foundation/solana-with-rpc-optimizations.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
solana-with-rpc-optimizations/docs
History
Michael Vines 4ada4d43f2 Drop the recommendation that `--expected-shred-version` be set by validators 
`--expected-shred-version` is another knob for users to get wrong and is
documentation that can get stale due to cluster restarts.  Turns out
it's also generally not required anymore either because:
1. The cluster entrypoint can always be expected to be using the correct
   shred version, and that shred version will be adopted by the new node
   (earlier this was not the case when the `solana-gossip spy` node on
   mainnet-beta.solana.com:8001 ran with shred version 0)
2. On a cluster restart, `--expected-bank-hash` is a much stronger
   assertion that the validator is starting from the correct place (and
   didn't exist when `--expected-shred-version` was first recommended)
 		2020-09-15 10:24:20 -07:00
..
.travis Move from gitbook to docusaurus, build docs in Travis CI (#10970) 2020-07-11 05:11:07 +00:00
art Cleanup programming model doc (#10274) 2020-05-27 16:18:11 -06:00
src Drop the recommendation that `--expected-shred-version` be set by validators 2020-09-15 10:24:20 -07:00
static Update logo (#12026) 2020-09-11 10:23:54 -04:00
.eslintrc Move from gitbook to docusaurus, build docs in Travis CI (#10970) 2020-07-11 05:11:07 +00:00
.gitignore Add package-lock.json to docs (#11200) 2020-07-24 14:15:22 -06:00
README.md Clean up docs publishing flow (#11043) 2020-07-14 07:56:14 -06:00
babel.config.js Move from gitbook to docusaurus, build docs in Travis CI (#10970) 2020-07-11 05:11:07 +00:00
build-cli-usage.sh Move from gitbook to docusaurus, build docs in Travis CI (#10970) 2020-07-11 05:11:07 +00:00
build.sh Update build.sh 2020-07-18 08:31:54 -06:00
convert-ascii-to-svg.sh Change transparent .svg to opaque .png (#11084) 2020-07-15 21:35:18 +00:00
docusaurus.config.js Comment that docs Algolia key is safe to publish 2020-08-18 05:25:51 +00:00
offline-cmd-md-links.sh Docs: Update CLI offline cmds (#8548) 2020-03-01 17:20:37 -07:00
package-lock.json Add package-lock.json to docs (#11200) 2020-07-24 14:15:22 -06:00
package.json Move from gitbook to docusaurus, build docs in Travis CI (#10970) 2020-07-11 05:11:07 +00:00
publish-docs.sh Clean up docs publishing flow (#11043) 2020-07-14 07:56:14 -06:00
set-solana-release-tag.sh Docs.rs version replacement (#11981) 2020-09-01 13:47:29 -06:00
sidebars.js Add SolFlare guide to docs (#11843) 2020-08-26 16:59:45 -06:00

README.md

Docs Readme

Solana's Docs are built using Docusaurus 2 with npm. Static content delivery is handled using vercel.

Installing Docusaurus

$ npm install

Local Development

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

$ npm run start

Build Locally

This command generates static content into the build directory and can be served using any static contents hosting service.

$ docs/build.sh

CI Build Flow

The docs are built and published in Travis CI with the docs/build.sh script. On each PR, the docs are built, but not published.

In each post-commit build, docs are built and published using vercel to their respective domain depending on the build branch.

  • Master branch docs are published to edge.docs.solana.com
  • Beta branch docs are published to beta.docs.solana.com
  • Latest release tag docs are published to docs.solana.com