solana-program-library/docs
Jon Cinque 6db3b29066
stake-pool: Add usage docs (#1277)
* stake-pool: Add usage docs

* More instructions

* Update for adding validator stake accounts

* Review feedback

* Update command output

* Add note about credits observed

* Finish stake pool docs

* Integrate review feedback

* Add motivation and design sections

* Add rebalancing example
2021-03-15 19:05:33 +01:00
..
.travis Implement docusaurus build, deployment and CI hooks (#129) 2020-07-16 10:13:45 -06:00
src stake-pool: Add usage docs (#1277) 2021-03-15 19:05:33 +01:00
static Update logos (#389) 2020-09-08 09:59:15 -06:00
.gitignore Implement docusaurus build, deployment and CI hooks (#129) 2020-07-16 10:13:45 -06:00
README.md adds program library logo and link back to docs (#191) 2020-08-03 07:31:23 -07:00
babel.config.js Implement docusaurus build, deployment and CI hooks (#129) 2020-07-16 10:13:45 -06:00
build.sh Implement docusaurus build, deployment and CI hooks (#129) 2020-07-16 10:13:45 -06:00
docusaurus.config.js Add Search functionality (#729) 2020-10-30 10:02:59 -07:00
package-lock.json Add Search functionality (#729) 2020-10-30 10:02:59 -07:00
package.json Add Search functionality (#729) 2020-10-30 10:02:59 -07:00
publish-docs.sh Implement docusaurus build, deployment and CI hooks (#129) 2020-07-16 10:13:45 -06:00
sidebars.js Initial feature proposal documentation 2020-11-18 19:59:23 +00:00
siteConfig.js adds program library logo and link back to docs (#191) 2020-08-03 07:31:23 -07:00

README.md

Docs Readme

SPL 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.

Documentation is published to spl.solana.com