Commit Graph

59 Commits

Author SHA1 Message Date
Nick Frostbutter 919b306733
[docs] updated page metadata and minor fixes (#35059)
feat: updated metadata
2024-02-02 16:55:11 -06:00
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
Raza eabe107066
[docs] Add beginner-friendly intro to Solana guide (#31861)
* Docs: Create intro to Solana guide

* Docs: Fix formatting on getstarted/overview

* Docs: Fix linter errors on getstarted/overview
2023-06-14 21:35:19 -05:00
Tim Garcia bcacb32cbc
[docs] Validator guidebook incorporated into docs (#31660)
* docs: adding multiple pages in from the guidebook

* fix: minor updates to the rpc node setup page

* fix: added known validators info to the rpc page

* docs: added best practices pages

* fix: updated internal linking

* docs: added faq page and update links

* Expanding the validator FAQ, updating hardware req

* Updates to validator setup

* Fixed broken RPC API links

* Remove GPU reqs, clarify install best practices

* Updating neworking requirements in validator reqs

* Removing trailing white spaces

* Removing systuner usage from docs

* ssh authentication note, more on withdrawls

* Adding feedback from educational workshop

* Details on system clock, cpu freq, validator set

* add link to gossip for clock drift system req

Co-authored-by: Nick Frostbutter <[email protected]>

* Update docs/src/validator/best-practices/monitoring.md

Co-authored-by: Nick Frostbutter <[email protected]>

* clarification on monitoring docs

Co-authored-by: Nick Frostbutter <[email protected]>

* adding a reference to the hardware requirements

Co-authored-by: Nick Frostbutter <[email protected]>

* fixing link to clusters page

Co-authored-by: Nick Frostbutter <[email protected]>

* typo fix

Co-authored-by: Nick Frostbutter <[email protected]>

* Update docs/src/validator/get-started/setup-a-validator.md

Co-authored-by: Nick Frostbutter <[email protected]>

* Update docs/src/validator/best-practices/monitoring.md

Co-authored-by: Nick Frostbutter <[email protected]>

* Update docs/src/validator/best-practices/monitoring.md

Co-authored-by: Nick Frostbutter <[email protected]>

* Referencing the validator health report

* Removed trailing whitespace

---------

Co-authored-by: nickfrosty <[email protected]>
Co-authored-by: Nick Frostbutter <[email protected]>
2023-06-13 14:11:37 -05:00
samkim-crypto 57a89a7ec8
[docs] Add zk token proof program description (#32011) 2023-06-13 11:13:51 +09:00
Nick Frostbutter 4564bcdc1a
[docs] state compression and compressed nfts (#31027)
* feat: added doc for state compression

* feat: added guide for compressed nfts

* fix: updates sidebar for new docs

* fix: added link to example repo

* fix: fixed typos

---------

Co-authored-by: nickfrosty <[email protected]>
2023-04-06 08:52:31 -05:00
Nick Frostbutter 9b270020f6
[docs] new JSON RPC API docs format (#29772)
* feat: added api page

* fix: api redirects

* feat: websocket page and partials

* feat: deprectated partials

* feat: http method partials

* fix: more deprecated partials

* feat: codeblock component and styles

* feat: api http methods page

* feat: sidebar

* refactor: proposal api links

* refactor: internal linking

* refactor: more internal links

* refactor: internal link and note cards

* refactor: local links

* refactor: local links and auto save prettier

* feat: added numNonVoteTransaction data details

* fix: updated getRecentPrioritizationFees

* fix: corrected wording

* fix: version typo

* fix: commitment links

* fix: parsed response links

* fix: dangling links

* refactor: filter criteria

* docs: removed jsonrpc-api.md file

* fix: dangling links

* style: removed whitespaces for CI

* style: removed whitespace

* style: fixed whitespaces
2023-01-26 17:14:47 -06:00
Nick Frostbutter d8da242e5e
docs: transactions fees/confirmation and deploying programs (#28895)
docs: adds and updates
2022-12-21 22:51:49 -06:00
Nick Frostbutter 5918d6f09d
[docs] updating the "writing programs" section (#29197)
* docs: added limitations page

* fix: updated deprecated cargo test-bpf

* docs: moved content off of overview

* fix: added compute budget description

* fix: updated compute buddget

* fix: rearranged sections

* fix: update code snippet

* docs: overview page and links
2022-12-21 22:27:10 -06:00
Alexey Skibin 108a02cfd4
Add off-chain messages support (#27456) 2022-10-17 11:19:12 -04:00
Nick Frostbutter c893f92508
[docs] versioned transactions and lookup tables (#28060)
* feat: added versioned transaction and ALT docs

* fix: relocated links and fixed sidebar parser
2022-09-27 07:16:18 +08:00
Nick Frostbutter cf1c44184c
[docs] quickstart guides (#27592)
* feat(wip): rust quickstart page

* feat: added quickstart pages

* fix: updated cards and card layout

* feat: added quickstart home (and to sidebar )

* fix: updated quickstarts

* fix: renamed to get started

* fix: typos and seo

* fix: JS example to interact with the onchain program
2022-09-10 02:36:04 +00: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 ad6b280b0a
[docs] Adding content pages under "developing" section (#26816)
* feat: added intro to dApps and programs pages

* style: removed whitespaces and updates MD syntax

* fix: spellcheck

* feat: what is rent page

* fix: fix typos and removed whitespaces

* fix: updated terminolgy

* feat: added what is web 3 page

* fix: removed dapps and web3 pages

* feat: added links to the developing sidebar

* fix: updated text based on comments

* fix: fixed link
2022-08-26 21:03:48 -05:00
Nick Frostbutter f6de4c6ccf
[docs] added commitment page (#27265)
feat: added commitment doc
2022-08-24 18:49:17 -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
Colin Ogoo d96edf4870 docs(integrations): docs for retrying transactions
Initial content from solana cookbook
2022-08-01 19:38:00 -06:00
Tyera Eulberg fbe5e51a16
Move duplicate-block proposal (#24167) 2022-04-07 17:30:31 -06:00
Tyera Eulberg 102dd68a03
Rename AccountsDb plugins to Geyser plugins (#23604) 2022-03-14 19:18:46 -06:00
Trent Nelson fa680a35ea docs: remove wallet ads 2022-02-16 22:19:10 -07:00
Lijun Wang 379e3ec848
Add Accountsdb plugin documentations (#21746)
Add the public facing documentation about the plugin framework: explaining the interface, how to load plugin and the example PostgreSQL plugin implementation.
Updated the rust documentation for the plugin interfaces for accounts and slot.
This changes are targeted for v1.8. Information about transactions will be updated later.
2021-12-10 15:54:40 -08:00
Justin Starry 03d3e0098e
docs: Remove outdated instructions for managing stake accounts (#20555) 2021-10-11 19:58:35 +00:00
cryptogosu b16f2da444
Added web3 reference guide (#19970)
Added web3 reference guide

Added web3 reference guide
2021-09-22 09:38:38 -04:00
Michael Vines b15fa9fbd2 Add EtcdTowerStorage 2021-08-14 09:46:36 -07:00
Michael Vines 5fe0350c2e Remove tour-de-sol/ 2021-07-15 19:43:53 -07:00
Trent Nelson 70d75ce4e8 docs: A-Z sort accepted proposals 2021-06-28 22:10:12 +00:00
Trent Nelson 0972d12c1c docs: expose TX v2 proposal 2021-06-28 22:10:12 +00:00
Trent Nelson 768a2ebe9d docs: Add docs for `solana-test-validator` 2021-05-13 17:28:31 +00: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
Trent Nelson 9c8be34906 docs: 'builtins' -> 'runtime facilities' 2021-03-11 08:38:18 +00:00
Trent Nelson 0e452c8d91 docs: rename 'deployed programs' section to 'on-chain programs' 2021-03-11 08:38:18 +00:00
Trent Nelson 3e6c7c4a3e docs: add rust client api entry 2021-03-11 08:38:18 +00:00
Jack May 82350f9350
deploy doc updates (#15109) 2021-02-04 16:18:14 -08:00
Jack May d0118a5c42
Add program deployment docs (#15075) 2021-02-04 01:30:50 -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
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 <[email protected]>

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

Co-authored-by: Eric Williams <[email protected]>

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

Co-authored-by: Eric Williams <[email protected]>

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

Co-authored-by: Eric Williams <[email protected]>

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

Co-authored-by: Eric Williams <[email protected]>

* Apply suggestions from code review

* Remove trailing whitespace

Co-authored-by: Eric Williams <[email protected]>
2021-01-14 17:04:04 +01:00
Tyera Eulberg 0f76daaf7a
Add specific page for rpc endpoints (#13899) 2020-12-01 21:19:15 -07:00
Jack May 13a08c7f08
Fix doc proposal sidebar layout (#13675) 2020-11-18 22:22:11 +00:00
Jack May 887b0e4b72
Add doc content and feedback (#13563) 2020-11-13 10:18:04 -08:00
Jack May 3d5e778d5d
Flesh out development docs (#13318)
* flesh out development docs

* nits
2020-11-03 20:53:17 +00:00
Tyera Eulberg a3912bc084 Add design proposal and update validator-timestamp-oracle 2020-10-31 21:30:42 -07:00
Justin Starry 458e9a1533
Codify breaking change guidelines (#13066)
* Codify breaking change guidelines

* feedback

* Rename title and add expectations section

* Update docs/src/apps/backwards-compatibility.md

Co-authored-by: Tyera Eulberg <[email protected]>

* Update docs/src/apps/backwards-compatibility.md

Co-authored-by: Tyera Eulberg <[email protected]>

* Update docs/src/apps/backwards-compatibility.md

Co-authored-by: Tyera Eulberg <[email protected]>

* Update docs/src/apps/backwards-compatibility.md

Co-authored-by: Tyera Eulberg <[email protected]>

* Update docs/src/apps/backwards-compatibility.md

Co-authored-by: Tyera Eulberg <[email protected]>

* Update docs/src/apps/backwards-compatibility.md

Co-authored-by: Tyera Eulberg <[email protected]>

* Update docs/src/apps/backwards-compatibility.md

Co-authored-by: Tyera Eulberg <[email protected]>

* Update backwards-compatibility.md

* Update docs/src/apps/backwards-compatibility.md

Co-authored-by: Trent Nelson <[email protected]>

* Update docs/src/apps/backwards-compatibility.md

Co-authored-by: Trent Nelson <[email protected]>

* Update docs/src/apps/backwards-compatibility.md

Co-authored-by: Trent Nelson <[email protected]>

* Apply suggestions from code review

Co-authored-by: Tyera Eulberg <[email protected]>
Co-authored-by: Trent Nelson <[email protected]>

* Specify rust crates and add deprecation process

* Promise semver for software releases

Co-authored-by: Tyera Eulberg <[email protected]>
Co-authored-by: Trent Nelson <[email protected]>
2020-10-31 09:45:18 +08:00
Tyera Eulberg 664b6125b6
Add doc page on sysvar accounts (#13237)
* Add doc page on sysvar accounts

* Update with suggestions
2020-10-28 14:54:36 -06:00
Dan Albert 0571882b1d
Add new wallets to docs, clean up existing structure (#12655)
* Add new wallets to docs

* Re-enstate SolFlare guide

* Update docs/src/wallet-guide/apps.md

Co-authored-by: Trent Nelson <[email protected]>

Co-authored-by: publish-docs.sh <[email protected]>
Co-authored-by: Trent Nelson <[email protected]>
2020-10-05 22:25:05 +00:00
Jack May 22d16c69b7
Add programming-faq to sidebar (#12586)
* Add programming-faq to sidebar

* nudge

* fix path
2020-09-30 09:56:48 +00:00
Michael Vines 6c23197f37 " 2020-09-29 23:09:55 -07:00
Michael Vines bc649da77d Add missing implemented design proposals to docs sidebar 2020-09-29 22:55:50 -07:00
Dan Albert 36e8441149
Add SolFlare guide to docs (#11843) 2020-08-26 16:59:45 -06:00
Dan Albert 6194a29875
Restore CLI usage page (#11619)
Co-authored-by: publish-docs.sh <[email protected]>
2020-08-13 16:02:13 -06: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