solana-with-rpc-optimizations/docs
Colin Ogoo 393c7653c7
fix(web3.js): VoteAccount.fromAccountData() throws range error (#21091)
* fix(vote-account): rangeError [ERR_OUT_OF_RANGE] error

The web3 buffer layout is out-of-date with the current `VoteState` implementation. The buffer layout
is updated to match the structure in
https://github.com/solana-labs/solana/blob/master/account-decoder/src/parse_vote.rs

fix #20786

* docs(vote account): update reference to match new payload

* fix(vote-account): update buffer layout for prior voters

Update buffer layout for prior voters to match serialized data

* fix(vote-account): response showing buffers instead of public keys

transform buffers into public keys

* refactor(vote account): extract parsing into function calls

* feat(vote account): address PR comments

* fix(web3.js vote account): start prior voters array from given index

* fix(web3.js vote account): incorrect data for prior voters array

* Update web3.js/src/vote-account.ts

Co-authored-by: Justin Starry <justin.m.starry@gmail.com>

Co-authored-by: Justin Starry <justin.m.starry@gmail.com>
2021-11-30 13:55:21 -05:00
..
.travis
art
src fix(web3.js): VoteAccount.fromAccountData() throws range error (#21091) 2021-11-30 13:55:21 -05:00
static Add new logos to README files and docs (#20049) 2021-09-21 13:35:36 -06:00
.eslintignore
.eslintrc
.gitignore feat: docs i18n support (continuation from #14818) (#17190) 2021-05-27 21:21:37 -07:00
.prettierignore
README.md Update README.md - fix two typos 2021-10-02 09:31:26 -07:00
babel.config.js
build-cli-usage.sh
build.sh feat: docs i18n support (continuation from #14818) (#17190) 2021-05-27 21:21:37 -07:00
convert-ascii-to-svg.sh
crowdin.yml feat: docs i18n support (continuation from #14818) (#17190) 2021-05-27 21:21:37 -07:00
docusaurus.config.js Remove Tour de SOL more 2021-07-16 03:25:35 +00: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
set-solana-release-tag.sh
sidebars.js docs: Remove outdated instructions for managing stake accounts (#20555) 2021-10-11 19:58:35 +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 opens 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 content 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