blockworks-foundation
/
solana
mirror of https://github.com/blockworks-foundation/solana.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
solana/docs
History
Jon Cinque ede891a6c6
docs: Clarify the commitment levels based on questions (#13387) 
* Clarify the commitment levels based on questions

Many people have asked about what commitment levels mean, and which to
choose.  This update includes some of the language at
`sdk/src/commitment_config.rs` and a recommendation for different use
cases.

Additionally, the preflight commitment documentation was out of date,
specifying that "max" was always used, and this is no longer the case.

* Update docs/src/developing/clients/jsonrpc-api.md

Co-authored-by: Tyera Eulberg <teulberg@gmail.com>

* Update docs/src/developing/clients/jsonrpc-api.md

Co-authored-by: Tyera Eulberg <teulberg@gmail.com>

* Update docs/src/developing/clients/jsonrpc-api.md

Co-authored-by: Tyera Eulberg <teulberg@gmail.com>

* Fix typo

Co-authored-by: Tyera Eulberg <teulberg@gmail.com>
 		2020-11-05 20:34:55 +01: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 docs: Clarify the commitment levels based on questions (#13387) 2020-11-05 20:34:55 +01:00
static Retry inflation parameter update along with documentation updates (#12778) 2020-10-12 13:10:57 -07: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 CI: Use branch-versioned cargo throughout 2020-11-05 05:05:57 +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 Retry inflation parameter update along with documentation updates (#12778) 2020-10-12 13:10:57 -07:00
offline-cmd-md-links.sh Docs: Update CLI offline cmds (#8548) 2020-03-01 17:20:37 -07:00
package-lock.json Retry inflation parameter update along with documentation updates (#12778) 2020-10-12 13:10:57 -07:00
package.json Retry inflation parameter update along with documentation updates (#12778) 2020-10-12 13:10:57 -07:00
publish-docs.sh Flesh out development docs (#13318) 2020-11-03 20:53:17 +00:00
set-solana-release-tag.sh Use latest stable channel release if there's no beta release 2020-10-12 21:57:38 +00:00
sidebars.js Flesh out development docs (#13318) 2020-11-03 20:53:17 +00: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