gaspersic/solana
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Files
b37dbed47950443eac553c6f56959add5e359ac5
solana/docs
History
Jon Cinque b37dbed479 docs: Add stake programming documentation (#14529) 
* Add stake programming documentation

We had some questions about stake programming documentation, and there
wasn't a place that contained information about the stake-o-matic and
other stake development in one place.  This adds a page with that
information.

* Update docs/src/staking/stake-programming.md

Co-authored-by: Eric Williams <eric@solana.com>

* Update docs/src/staking/stake-programming.md

Co-authored-by: Eric Williams <eric@solana.com>

* Update docs/src/staking/stake-programming.md

Co-authored-by: Eric Williams <eric@solana.com>

* Update docs/src/staking/stake-programming.md

Co-authored-by: Eric Williams <eric@solana.com>

* Update docs/src/staking/stake-programming.md

Co-authored-by: Eric Williams <eric@solana.com>

* Apply suggestions from code review

* Remove trailing whitespace

Co-authored-by: Eric Williams <eric@solana.com>
2021-01-14 17:04:04 +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: Add stake programming documentation (#14529)
2021-01-14 17:04:04 +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
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
Report and bail on broken links (#13540)
2020-11-11 17:46:24 -08:00
convert-ascii-to-svg.sh
Change transparent .svg to opaque .png (#11084)
2020-07-15 21:35:18 +00:00
docusaurus.config.js
Report and bail on broken links (#13540)
2020-11-11 17:46:24 -08:00
offline-cmd-md-links.sh
Docs: Update CLI offline cmds (#8548)
2020-03-01 17:20:37 -07:00
package-lock.json
Report and bail on broken links (#13540)
2020-11-11 17:46:24 -08:00
package.json
Report and bail on broken links (#13540)
2020-11-11 17:46:24 -08:00
publish-docs.sh
fix doc redirects (#13709)
2020-11-19 21:34:21 +00:00
README.md
Clean up docs publishing flow (#11043)
2020-07-14 07:56:14 -06:00
set-solana-release-tag.sh
Guard against bsd sed (#13735)
2020-11-21 17:56:23 -08:00
sidebars.js
docs: Add stake programming documentation (#14529)
2021-01-14 17:04:04 +01: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