`--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) |
||
---|---|---|
.. | ||
.travis | ||
art | ||
src | ||
static | ||
.eslintrc | ||
.gitignore | ||
README.md | ||
babel.config.js | ||
build-cli-usage.sh | ||
build.sh | ||
convert-ascii-to-svg.sh | ||
docusaurus.config.js | ||
offline-cmd-md-links.sh | ||
package-lock.json | ||
package.json | ||
publish-docs.sh | ||
set-solana-release-tag.sh | ||
sidebars.js |
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