Commit Graph

23 Commits

Author SHA1 Message Date
Nick Frostbutter 676e80c80a
[docs] docs migration (#34096)
* feat: moved common docs to  repo

* refactor: removed sidebar items

* refactor: removed unused images

* fix: terminology link

* fix: introduction links

* fix: developing links

* refactor: fixed assorted links

* fix: added back the home index

* refactor: home page links

* refactor: primary links

* fix: links

* fix: updated existing redirects

* feat: added new redirects

* refactor: moved cli index file to cli folder

* feat: turned breadcrumbs on

* feat: auto generated cli sidebar

* refactor: page titles

* feat: added usage and wallets categories

* refactor: moved wallet-guide/cli

* style: page titles

* refactor: renamed file to install

* style: page title

* refactor: relocated file to cli/usage/index.md

* style: page title

* refactor: relocat detailed usage generator for cli commands

* refactor: relocated clie usage files

* refactor: relocated paper wallet file

* refactor: relocated file system wallet doc

* feat: added hardware wallet category

* refactor: relocated hardware wallet overview

* refactor: relocated ledger wallet doc

* style: clie wallet titles

* refactor(revert): relocated cli usage doc

* refactor: relocated to examples

* style: cli examples category title

* style: usage doc title

* refactor: relocated cli intro doc

* style: category title

* refactor: renamed file

* refactor: renamed file

* fix: cli links

* refactor: relocated file

* refactor: relocated files

* fix: more cli links

* refactor: sidebar order

* fix: final cli links?

* refactor: proposals

* refactor: split sidebars

* refactor: removed unused icons

* refactor: relocated file

* refactor: relocated file

* refactor: relocated file

* refactor: relocated file

* feat: added architecture page

* refactor: reloacted filed

* refactor: adjusted header links

* style: sidebar labels

* feat: clusters sidebar details

* style: sidebar label

* refactor: relocate file

* refactor: relocated files

* refactor: relocated files

* refactor: relocated files

* style: validator sidebar

* style: sidebar styles

* refactor: internal links

* style: sidebar order

* fix: internal links

* feat: master sidebar

* refactor: removed unneeded h2

* fix: link redirects

* refactor: relocated pages

* style: runtime links

* refactor: simplified runtime redirects

* fix: internal redirect

* refactor: moved proposals to dropdown

* docs: Removes accounts-on-ramdisk section (#33655)

* RPC: update websocket docs (#33460)

* [rpc]: update websocket docs

* rename rewards to showRewards

* add remaining optional fields for slotsUpdates

* update block subscription showRewards

* Change getHealth to compare optimistically confirmed slots (#33651)

The current getHealth mechanism checks a local accounts hash slot vs.
those of other nodes as specified by --known-validator. This is a
very coarse comparison given that the default for this value is 100
slots. More so, any nodes using a value larger than the default
(ie --incremental-snapshot-interval 500) will likely see getHealth
return status behind at some point.

Change the underlying mechanism of how health is computed. Instead of
using the accounts hash slots published in gossip, use the latest
optimistically confirmed slot from the cluster. Even when a node is
behind, it is able to observe cluster optimistically confirmed by slots
by viewing votes published in gossip.

Thus, the latest cluster optimistically confirmed slot can be compared
against the latest optimistically confirmed bank from replay to
determine health. This new comparison is much more granular, and not
needing to depend on individual known validators is also a plus.

* build(deps): bump @babel/traverse from 7.19.6 to 7.23.2 in /docs (#33726)

Bumps [@babel/traverse](https://github.com/babel/babel/tree/HEAD/packages/babel-traverse) from 7.19.6 to 7.23.2.
- [Release notes](https://github.com/babel/babel/releases)
- [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md)
- [Commits](https://github.com/babel/babel/commits/v7.23.2/packages/babel-traverse)

---
updated-dependencies:
- dependency-name: "@babel/traverse"
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* docs: move rpc info to rpc docs (#33723)

docs: link fixes

docs: link fixes

docs: link fixes

* Fix typos in documentation for Secp256k1 native program (#33796)

* docs: outline requirement of stake in order to vote (#33842)

* docs: outline requirement of stake in order to vote

* pr feedback: move stake section up

* chore: fix some typos (#33833)

* fix spelling of "retrieved"
* fix spelling of "should"
* fix spelling of "comparisons"

* docs: updating apt install to apt upgrade (#33920)

* Fix some typo in the documentation (#34058)

Co-authored-by: Andrew Fitzgerald <[email protected]>

* fix: internal links

* refactor: removed rpc api docs

* refactor: removed rpc sidebar

* fix: updated remaining rpc api links

* refactor: removed final rpc /api route

* refactor: removed dangling component files

* refactor: changed copyright

* fix: dangling ordered list

* refactor: wording around solana docs

* feat: home page content

* refactor: updated docs url

* Link to latest version of the off-chain message signing proposal in the docs (#34329)

* docs: (cli) minor updates to deploy-a-program.md (#34307)

* docs: (cli) minor updates to deploy-a-program.md

* address review comments

* remove unnecessary impl details from the docs about deploy command upgrade flow

* clarify program redeploy section

---------

Co-authored-by: norwnd <norwnd>

* refactor: removed GA

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Brooks <[email protected]>
Co-authored-by: Joe C <[email protected]>
Co-authored-by: steviez <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Jacob Creech <[email protected]>
Co-authored-by: Nick Guo <[email protected]>
Co-authored-by: Ashwin Sekar <[email protected]>
Co-authored-by: Kevin Heavey <[email protected]>
Co-authored-by: Max Kaplan <[email protected]>
Co-authored-by: hugo-syn <[email protected]>
Co-authored-by: Andrew Fitzgerald <[email protected]>
Co-authored-by: norwnd <[email protected]>
2023-12-11 14:17:13 -06:00
Nick Frostbutter ac761dd9c0
[docs] added google analytics to docs (#31141)
* feat: added google analytics to docs

* docs: added comments
2023-04-11 14:35:40 -05:00
Brennan 000b912fc6
Update discord invite links (#30909)
* Update discord invite links

* Point to Stack Exchange for support
2023-03-29 09:14:22 -07:00
Nick Frostbutter a131163904
fix: fixed and/or removed forum links (#30775)
* fix: fixed and/or removed forum links

Closes #29724

* fix: typo

---------

Co-authored-by: nickfrosty <[email protected]>
2023-03-20 13:58:41 -05:00
Nick Frostbutter 1345e89507
docs: update Docusaurus to v2.2 (#29563)
* build: update docusaurus

* fix: algolia keys

* fix: frontmatter keywords array

* build: clsx version

* fix: card layout and pages

* fix: invalid internal link
2023-01-17 22:13:10 -06:00
Nick Frostbutter 1f8258f547
[docs] developers home page (#27436)
* feat: developers landing page

* fix: updated links

* fix: updated labels for translateIds

* refactor: updated index page to use Card component

* style: removed whitespace

* refactor: added static labels for developer sidebar items

* feat: developer's sidebar and new layout file

* chore: removed whitespace

* fix: removed duplicate CLI sidebar item

* fix: card shadows and RPC card text
2022-08-31 12:32:36 -05:00
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
Michael Vines c03490b24a Remove Tour de SOL more 2021-07-16 03:25:35 +00:00
Tim Hagn 53c91ee89e
feat: docs i18n support (continuation from #14818) (#17190)
* Initial commit for i18n support

* Bring out index page

* Lint
	modified:   src/pages/index.js

* More Crowdin ephemera

* copy src content to i18n/**/docusaurus-plugin-content-docs/current folders

* run write-translations

* remove superflous files in i18n

* fix formatting

* remove icons folders from translations, add ja, pt, vi translations

* fix formatting

* update translation JSON files

* add crowdin support & crowdin:sync command, sync with crowdin

* exclude failing locales

* remove i18n from git cache, add write-heading-ids script

* add crowdin:sync to before_install.sh script

* add write-i18m shortening script & crowdin:download script (also to before_install.sh)

* move crowdin:download from before_install.sh to prebuild hook

* remove prebuild hook

* remove crowdin script, bump deps

* re-add cli/usage

* update package-lock.json

* add translation sync to build.sh for master

* update README

* add ja to localesNotBuilding, write e-ids

* fix formatting

* get on sync with master

* replace check for master branch

* change build script to work on travis

* use refs instead of names

* fix build.sh

* replace head ref check with channel check

* get stable channel in build.sh

* remove zip

* remove header ids

Co-authored-by: rmshea <[email protected]>
2021-05-27 21:21:37 -07:00
Ryan M. Shea c65c4475f6
Add Contextual Search (#17299)
* this should prevent other language results appearing in the search area
2021-05-18 05:47:19 +00:00
Justin Starry a1df57a4ea
Add chinese translations to docs (#17125)
* import zh translations

* Fix broken links

* fix whitespace
2021-05-09 00:46:24 +08:00
Justin Starry 545e037e38
Docs cleanup (#16964)
* Run lint:fix on docs

* Update dependencies

* Run prettier

* Run lint
2021-04-30 16:20:56 +08:00
Eric Williams 5594a7122d
Reorg and cleanup of economics section of docs (#14868)
* reorg validator economics

* overview cleanup

* terminology

* terminology formatting

* katex for docusaurus

* adjusted staking yield writeup

* more reorg

* move section header

* rm unlinked mds

* add new mds

* Update docs/src/inflation/terminology.md

Co-authored-by: Dan Albert <[email protected]>

* Update docs/src/inflation/terminology.md

Co-authored-by: Dan Albert <[email protected]>

* Update docs/src/inflation/terminology.md

Co-authored-by: Dan Albert <[email protected]>

* Update docs/src/inflation/terminology.md

Co-authored-by: Dan Albert <[email protected]>

* Update docs/src/inflation/terminology.md

Co-authored-by: Dan Albert <[email protected]>

* Update docs/src/transaction_fees.md

Co-authored-by: Dan Albert <[email protected]>

* addressing Dans comments in #14868

* incorporating pr commits

* trailing whitespaces

* more trailing whitespaces

* remove services link and add plot

* add plots

Co-authored-by: Dan Albert <[email protected]>
2021-01-27 22:54:00 +01:00
Jack May eb306da148
Report and bail on broken links (#13540) 2020-11-11 17:46:24 -08:00
Eric Williams 1ab36203de
Retry inflation parameter update along with documentation updates (#12778)
* update initial inflation parameter

* update economics section of docs
2020-10-12 13:10:57 -07:00
Trent Nelson 0413a305d2 Comment that docs Algolia key is safe to publish 2020-08-18 05:25:51 +00:00
Raj Gokal 14dcaaee6c
Link fix (#11368)
* fixes logo

* cleans up homepage on docs

* adds icon files and tightens margins

* cleans up sidenav, adds top nav items

* fixes a link

* removes icon files

Co-authored-by: Dan Albert <[email protected]>
2020-08-06 13:19:35 -06:00
Raj Gokal e2789b9373 cross-links SPL library 2020-08-01 08:33:26 -07:00
Dan Albert cd043b5d70
Add top level link to Clusters page (#11276)
Co-authored-by: publish-docs.sh <[email protected]>
2020-07-29 21:27:25 +00:00
R. M. Shea cbf0b779d7
Add Docusaurus search (#11135)
* Add Docusaurus search

* Add Algolia configuration information

* Trailing whitespace :(

Co-authored-by: Ryan Shea <[email protected]>
2020-07-27 10:26:03 -06:00
Dan Albert d0d4d9b3d1
Fix 404 broken links (#11113)
Co-authored-by: publish-docs.sh <[email protected]>
2020-07-17 17:48:07 +00:00
Dan Albert 6342e3e215
Refactor file and URL paths in docusaurus (#11080)
* Fix introduction link

* Restore staking guide pages

* Remove Edit this page link

* Fix broken wallet guide link

* Restore lost images

* Fixup URL paths to match gitbook style

* Refactor wallet guide READMEs and clean up URLs

* Remove lingering gitbook files

* Refactor all README files to keep consistent linking

* Updte homepage tile links

Co-authored-by: publish-docs.sh <[email protected]>
2020-07-15 20:11:51 +00:00
Dan Albert ffeac298a2
Move from gitbook to docusaurus, build docs in Travis CI (#10970)
* fix: ignore unknown fields in more RPC responses

* Remove mdbook infrastructure

* Delete gitattributes and other theme related items

Move all docs to /docs folder to support Docusaurus

* all docs need to be moved to /docs

* can be changed in the future

Add Docusaurus infrastructure

* initialize docusaurus repo

Remove trailing whitespace, add support for eslint

Change Docusaurus configuration to support `src`

* No need to rename the folder! Change a setting and we're all good to
go.

* Fixing rebase items

* Remove unneccessary markdown file, fix type

* Some fonts are hard to read. Others, not so much. Rubik, you've been
sidelined. Roboto, into the limelight!

* As much as we all love tutorials, I think we all can navigate around a
markdown file. Say goodbye, `mdx.md`.

* Setup deployment infrastructure

* Move docs job from buildkite to travic

* Fix travis config

* Add vercel token to travis config

* Only deploy docs after merge

* Docker rust env

* Revert "Docker rust env"

This reverts commit f84bc208e807aab1c0d97c7588bbfada1fedfa7c.

* Build CLI usage from docker

* Pacify shellcheck

* Run job on PR and new commits for publication

* Update README

* Fix svg image building

* shellcheck

Co-authored-by: Michael Vines <[email protected]>
Co-authored-by: Ryan Shea <[email protected]>
Co-authored-by: publish-docs.sh <[email protected]>
2020-07-11 05:11:07 +00:00