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
Nick Frostbutter 5f195ba242
[docs] Docs sidebar/navbar restructure (#27005) 
* fix: minor title changes

* fix: updated structure of 2 pages

* fix: proposals page and submitting one

added proposals page and made it clear how to submit one

* fix: minor update to docs home page

* fix: footer links

added more footer links and minor restructure

* fix: sidebar restructure

* fix: removed duplicate geyser link

* fix: sidebars and navbar

final separation of sidebars and updated navbar

* fix: formatting for the navbar icons

* fix: changes some sidebar links to refs

* style: changed order of footer's SPL link

* style: removed comment and fixed whitespace check
 		2022-08-15 21:23:39 -05: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 [docs] Docs sidebar/navbar restructure (#27005) 2022-08-15 21:23:39 -05:00
static docs(integrations): docs for retrying transactions 2022-08-01 19:38:00 -06: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
.prettierrc.json [docs] added prettier config file (#26817) 2022-07-28 10:44:02 -07:00
README.md Update README.md - fix two typos 2021-10-02 09:31:26 -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 docs-ci: prebuild cli bin with output to appease TravisCI hang check 2022-02-02 08:29:57 +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 docs: resolve svgbob binary 2022-02-28 17:33:30 -07:00
crowdin.yml feat: docs i18n support (continuation from #14818) (#17190) 2021-05-27 21:21:37 -07:00
docusaurus.config.js [docs] Docs sidebar/navbar restructure (#27005) 2022-08-15 21:23:39 -05:00
offline-cmd-md-links.sh Docs: Update CLI offline cmds (#8548) 2020-03-01 17:20:37 -07:00
package-lock.json docs: revert unintentional packaging changes 2022-06-24 23:08:27 +00:00
package.json feat: docs i18n support (continuation from #14818) (#17190) 2021-05-27 21:21:37 -07:00
publish-docs.sh fix: fixed the incorrect/unknown redirects 2022-08-05 22:30:32 -05:00
set-solana-release-tag.sh Guard against bsd sed (#13735) 2020-11-21 17:56:23 -08:00
sidebars.js [docs] Docs sidebar/navbar restructure (#27005) 2022-08-15 21:23:39 -05:00
yarn.lock docs: revert unintentional packaging changes 2022-06-24 23:08:27 +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 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