Files

mergify[bot] 6e214bbc04 Docs fixups (bp #15801 ) (#15802 )

* docs: add docs links for crates published to crates.io

(cherry picked from commit 24d18b3cf2)

# Conflicts:
#	core/Cargo.toml
#	measure/Cargo.toml
#	programs/bpf/rust/finalize/Cargo.toml

* docs: add rust client api entry

(cherry picked from commit 3e6c7c4a3e)

* docs: rename 'deployed programs' section to 'on-chain programs'

(cherry picked from commit 0e452c8d91)

* docs: 'builtins' -> 'runtime facilities'

(cherry picked from commit 9c8be34906)

* docs: stabilize spl token jsonrpc methods

(cherry picked from commit 45190f6281)

* docs: deprecate lastvalidslot field of jsonrpc getfees

(cherry picked from commit c4ee1ab710)

Co-authored-by: Trent Nelson <trent@solana.com>

2021-03-11 21:49:14 +00: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 fixups (bp #15801 ) (#15802 )

2021-03-11 21:49:14 +00:00

static

Reorg and cleanup of economics section of docs (#14868 ) (#14889 )

2021-01-28 16:07:31 -07:00

.eslintrc

Move from gitbook to docusaurus, build docs in Travis CI (#10970 )

2020-07-11 05:11:07 +00:00

.gitignore

Fix cli usage build

2021-01-29 11:45:56 -08: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

Fix cli usage build

2021-01-29 11:45:56 -08:00

build.sh

Only publish release-tag docs on beta channel (#15158 ) (#15168 )

2021-02-06 06:59:09 +00:00

convert-ascii-to-svg.sh

Change transparent .svg to opaque .png (#11084 )

2020-07-15 21:35:18 +00:00

docusaurus.config.js

Reorg and cleanup of economics section of docs (#14868 ) (#14889 )

2021-01-28 16:07:31 -07:00

offline-cmd-md-links.sh

Docs: Update CLI offline cmds (#8548 )

2020-03-01 17:20:37 -07:00

package-lock.json

Reorg and cleanup of economics section of docs (#14868 ) (#14889 )

2021-01-28 16:07:31 -07:00

package.json

Reorg and cleanup of economics section of docs (#14868 ) (#14889 )

2021-01-28 16:07:31 -07:00

publish-docs.sh

Docs fixups (bp #15801 ) (#15802 )

2021-03-11 21:49:14 +00:00

README.md

Add security best practice sections (#14798 )

2021-01-26 08:53:54 -08:00

set-solana-release-tag.sh

Guard against bsd sed (#13735 )

2020-11-21 17:56:23 -08:00

sidebars.js

Docs fixups (bp #15801 ) (#15802 )

2021-03-11 21:49:14 +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. (You might have to run build.sh first if you run into failures)

$ 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