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
Justin Starry 191519188d
Add proposal for transactions v2 and address map program (#17103) 
* Add proposal for supporting big transactions

* account index program

* fix formatting

* review feedback

* Add cost changes section

* Add cost section and more attack details

* fix lint

* document metadata changes

* nit

* rpc details

* add index meta struct

* add additional proposal and chagne title

* rename proposal file

* rename to address map and rewrite tx format

* no more appends, limit mapping size to 256

* update dos section

* add note about readonly

* restructure message to use enum

* cleanup
 		2021-06-10 17:38:00 -07:00
..
.travis Move from gitbook to docusaurus, build docs in Travis CI (#10970) 2020-07-11 05:11:07 +00:00
art Update retransmit docs to move deshredder and rename (#16229) 2021-03-30 15:37:33 -07:00
src Add proposal for transactions v2 and address map program (#17103) 2021-06-10 17:38:00 -07:00
static Reorg and cleanup of economics section of docs (#14868) 2021-01-27 22:54:00 +01:00
.eslintignore Docs cleanup (#16964) 2021-04-30 16:20:56 +08:00
.eslintrc Move from gitbook to docusaurus, build docs in Travis CI (#10970) 2020-07-11 05:11:07 +00:00
.gitignore feat: docs i18n support (continuation from #14818) (#17190) 2021-05-27 21:21:37 -07:00
.prettierignore Docs cleanup (#16964) 2021-04-30 16:20:56 +08:00
README.md feat: docs i18n support (continuation from #14818) (#17190) 2021-05-27 21:21:37 -07: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 19:03:10 +00:00
build.sh feat: docs i18n support (continuation from #14818) (#17190) 2021-05-27 21:21:37 -07:00
convert-ascii-to-svg.sh Change transparent .svg to opaque .png (#11084) 2020-07-15 21:35:18 +00:00
crowdin.yml feat: docs i18n support (continuation from #14818) (#17190) 2021-05-27 21:21:37 -07:00
docusaurus.config.js feat: docs i18n support (continuation from #14818) (#17190) 2021-05-27 21:21:37 -07:00
offline-cmd-md-links.sh
…
package-lock.json feat: docs i18n support (continuation from #14818) (#17190) 2021-05-27 21:21:37 -07:00
package.json feat: docs i18n support (continuation from #14818) (#17190) 2021-05-27 21:21:37 -07:00
publish-docs.sh docs: rename 'deployed programs' section to 'on-chain programs' 2021-03-11 08:38:18 +00:00
set-solana-release-tag.sh Guard against bsd sed (#13735) 2020-11-21 17:56:23 -08:00
sidebars.js docs: Add docs for `solana-test-validator` 2021-05-13 17:28:31 +00:00
yarn.lock feat: docs i18n support (continuation from #14818) (#17190) 2021-05-27 21:21:37 -07: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

Translations

Translations are sourced from Crowdin and generated when master is built. For local development use the following two commands in the docs directory.

To download the newest Documentation translations run:

npm run crowdin:download

To upload changes from src & generate explicit IDs:

npm run crowdin:upload

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