Skip to content
This repository was archived by the owner on Jan 22, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
103 commits
Select commit Hold shift + click to select a range
357a924
feat: moved common docs to repo
nickfrosty Oct 6, 2023
9ace3fe
refactor: removed sidebar items
nickfrosty Nov 7, 2023
9170af1
refactor: removed unused images
nickfrosty Nov 7, 2023
ba74ff7
fix: terminology link
nickfrosty Nov 7, 2023
e35c436
fix: introduction links
nickfrosty Nov 7, 2023
caf3c62
fix: developing links
nickfrosty Nov 7, 2023
d53713c
refactor: fixed assorted links
nickfrosty Nov 7, 2023
19863e0
fix: added back the home index
nickfrosty Nov 7, 2023
8af6af8
refactor: home page links
nickfrosty Nov 7, 2023
0a3ab4a
refactor: primary links
nickfrosty Nov 7, 2023
2683492
fix: links
nickfrosty Nov 7, 2023
2b2e72d
fix: updated existing redirects
nickfrosty Nov 7, 2023
a66b5c1
feat: added new redirects
nickfrosty Nov 7, 2023
d95bba0
refactor: moved cli index file to cli folder
nickfrosty Nov 13, 2023
c7232cf
feat: turned breadcrumbs on
nickfrosty Nov 13, 2023
a8bf663
feat: auto generated cli sidebar
nickfrosty Nov 13, 2023
ed9c5eb
refactor: page titles
nickfrosty Nov 13, 2023
86b8f18
feat: added usage and wallets categories
nickfrosty Nov 13, 2023
24dd9b8
refactor: moved wallet-guide/cli
nickfrosty Nov 13, 2023
0dafb4b
style: page titles
nickfrosty Nov 13, 2023
a700d24
refactor: renamed file to install
nickfrosty Nov 13, 2023
cc529fa
style: page title
nickfrosty Nov 13, 2023
853b396
refactor: relocated file to cli/usage/index.md
nickfrosty Nov 13, 2023
26e3da6
style: page title
nickfrosty Nov 13, 2023
cc3033d
refactor: relocat detailed usage generator for cli commands
nickfrosty Nov 13, 2023
bdcb4ab
refactor: relocated clie usage files
nickfrosty Nov 13, 2023
1b30582
refactor: relocated paper wallet file
nickfrosty Nov 13, 2023
4b946fc
refactor: relocated file system wallet doc
nickfrosty Nov 13, 2023
bacb688
feat: added hardware wallet category
nickfrosty Nov 13, 2023
2ad012e
refactor: relocated hardware wallet overview
nickfrosty Nov 13, 2023
09c651a
refactor: relocated ledger wallet doc
nickfrosty Nov 13, 2023
6793ec5
style: clie wallet titles
nickfrosty Nov 13, 2023
c9e0066
refactor(revert): relocated cli usage doc
nickfrosty Nov 13, 2023
991a4b8
refactor: relocated to examples
nickfrosty Nov 13, 2023
8e221a2
style: cli examples category title
nickfrosty Nov 13, 2023
3f4cd30
style: usage doc title
nickfrosty Nov 13, 2023
b36c577
refactor: relocated cli intro doc
nickfrosty Nov 13, 2023
ba0457c
style: category title
nickfrosty Nov 13, 2023
cc12d66
refactor: renamed file
nickfrosty Nov 13, 2023
818013c
refactor: renamed file
nickfrosty Nov 13, 2023
b365a4a
fix: cli links
nickfrosty Nov 13, 2023
b13ce5c
refactor: relocated file
nickfrosty Nov 13, 2023
9f4ac4d
refactor: relocated files
nickfrosty Nov 13, 2023
daf7dd0
fix: more cli links
nickfrosty Nov 13, 2023
e0432c7
refactor: sidebar order
nickfrosty Nov 13, 2023
1fed4e2
fix: final cli links?
nickfrosty Nov 13, 2023
64b6a23
refactor: proposals
nickfrosty Nov 13, 2023
44bf9c7
refactor: split sidebars
nickfrosty Nov 13, 2023
bdfa3d2
refactor: removed unused icons
nickfrosty Nov 13, 2023
72d8c14
refactor: relocated file
nickfrosty Nov 14, 2023
a04d984
refactor: relocated file
nickfrosty Nov 14, 2023
b2a9b8a
refactor: relocated file
nickfrosty Nov 14, 2023
417dad3
refactor: relocated file
nickfrosty Nov 14, 2023
0236a51
feat: added architecture page
nickfrosty Nov 14, 2023
d3fa2d0
refactor: reloacted filed
nickfrosty Nov 14, 2023
810a688
refactor: adjusted header links
nickfrosty Nov 14, 2023
3e79732
style: sidebar labels
nickfrosty Nov 14, 2023
8ef22ab
feat: clusters sidebar details
nickfrosty Nov 14, 2023
9a2a032
style: sidebar label
nickfrosty Nov 14, 2023
e9248a2
refactor: relocate file
nickfrosty Nov 14, 2023
4e74fe9
refactor: relocated files
nickfrosty Nov 14, 2023
79a3dd5
refactor: relocated files
nickfrosty Nov 14, 2023
95725fe
refactor: relocated files
nickfrosty Nov 14, 2023
d491b0e
style: validator sidebar
nickfrosty Nov 14, 2023
fa44b6d
style: sidebar styles
nickfrosty Nov 15, 2023
40ee349
refactor: internal links
nickfrosty Nov 15, 2023
792cd62
style: sidebar order
nickfrosty Nov 15, 2023
a0ab7d2
fix: internal links
nickfrosty Nov 15, 2023
82d244b
feat: master sidebar
nickfrosty Nov 15, 2023
af37003
refactor: removed unneeded h2
nickfrosty Nov 15, 2023
9ec8778
fix: link redirects
nickfrosty Nov 15, 2023
a0801e6
refactor: relocated pages
nickfrosty Nov 15, 2023
9e8b902
style: runtime links
nickfrosty Nov 15, 2023
302919e
refactor: simplified runtime redirects
nickfrosty Nov 15, 2023
c56d844
fix: internal redirect
nickfrosty Nov 15, 2023
ed1f058
refactor: moved proposals to dropdown
nickfrosty Nov 15, 2023
020a65c
docs: Removes accounts-on-ramdisk section (#33655)
brooksprumo Oct 11, 2023
812d8d5
RPC: update websocket docs (#33460)
Oct 16, 2023
e8e87d5
Change getHealth to compare optimistically confirmed slots (#33651)
Oct 16, 2023
6601960
build(deps): bump @babel/traverse from 7.19.6 to 7.23.2 in /docs (#33…
dependabot[bot] Oct 17, 2023
357e574
docs: move rpc info to rpc docs (#33723)
jacobcreech Oct 17, 2023
a155738
Fix typos in documentation for Secp256k1 native program (#33796)
nickguo Oct 23, 2023
de1eb73
docs: outline requirement of stake in order to vote (#33842)
AshwinSekar Oct 25, 2023
a782ee0
chore: fix some typos (#33833)
kevinheavey Oct 25, 2023
eda8681
docs: updating apt install to apt upgrade (#33920)
kaplanmaxe Nov 6, 2023
012bcfa
Fix some typo in the documentation (#34058)
hugo-syn Nov 14, 2023
dd33d05
Merge branch 'master' into docs-migration
nickfrosty Nov 15, 2023
ae3a745
fix: internal links
nickfrosty Nov 15, 2023
067c2d2
refactor: removed rpc api docs
nickfrosty Nov 16, 2023
96c5f42
refactor: removed rpc sidebar
nickfrosty Nov 17, 2023
39bbc3c
fix: updated remaining rpc api links
nickfrosty Nov 17, 2023
8c8f908
refactor: removed final rpc /api route
nickfrosty Nov 17, 2023
530aaee
refactor: removed dangling component files
nickfrosty Nov 17, 2023
aaf40d5
refactor: changed copyright
nickfrosty Nov 28, 2023
5332653
fix: dangling ordered list
nickfrosty Nov 30, 2023
6845c02
refactor: wording around solana docs
nickfrosty Dec 1, 2023
8949881
feat: home page content
nickfrosty Dec 1, 2023
9194339
refactor: updated docs url
nickfrosty Dec 1, 2023
8695582
Link to latest version of the off-chain message signing proposal in t…
nickfrosty Dec 7, 2023
3b29a5a
docs: (cli) minor updates to deploy-a-program.md (#34307)
norwnd Dec 7, 2023
705f317
Merge branch 'master' into docs-migration
nickfrosty Dec 8, 2023
60245b4
Merge branch 'master' into docs-migration
nickfrosty Dec 11, 2023
f5314ea
refactor: removed GA
nickfrosty Dec 11, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fix: terminology link
  • Loading branch information
nickfrosty committed Nov 7, 2023
commit ba74ff78fc7d09979cb2c4281b580c45c7720cfd
5 changes: 4 additions & 1 deletion docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,10 @@ module.exports = {
label: "More",
position: "left",
items: [
{ label: "Terminology", to: "terminology" },
{
label: "Terminology",
href: "https://solana.com/docs/terminology",
},
{ label: "Staking", to: "staking" },
{ label: "Integrations", to: "integrations/exchange" },
{ label: "Economics", to: "economics_overview" },
Expand Down
2 changes: 1 addition & 1 deletion docs/src/api/deprecated/_getFees.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ The result will be an RpcResponse JSON object with `value` set to a JSON object
- `blockhash: <string>` - a Hash as base-58 encoded string
- `feeCalculator: <object>` - FeeCalculator object, the fee schedule for this block hash
- `lastValidSlot: <u64>` - DEPRECATED - this value is inaccurate and should not be relied upon
- `lastValidBlockHeight: <u64>` - last [block height](../../terminology.md#block-height) at which the blockhash will be valid
- `lastValidBlockHeight: <u64>` - last [block height](https://solana.com/docs/terminology#block-height) at which the blockhash will be valid

</CodeParams>

Expand Down
2 changes: 1 addition & 1 deletion docs/src/api/methods/_getBlock.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ Transactions are quite different from those on other blockchains. Be sure to rev

The JSON structure of a transaction is defined as follows:

- `signatures: <array[string]>` - A list of base-58 encoded signatures applied to the transaction. The list is always of length `message.header.numRequiredSignatures` and not empty. The signature at index `i` corresponds to the public key at index `i` in `message.accountKeys`. The first one is used as the [transaction id](../../terminology.md#transaction-id).
- `signatures: <array[string]>` - A list of base-58 encoded signatures applied to the transaction. The list is always of length `message.header.numRequiredSignatures` and not empty. The signature at index `i` corresponds to the public key at index `i` in `message.accountKeys`. The first one is used as the [transaction id](https://solana.com/docs/terminology#transaction-id).
- `message: <object>` - Defines the content of the transaction.
- `accountKeys: <array[string]>` - List of base-58 encoded public keys used by the transaction, including by the instructions and for signatures. The first `message.header.numRequiredSignatures` public keys must sign the transaction.
- `header: <object>` - Details the account types and signatures required by the transaction.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/api/methods/_getLatestBlockhash.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Configuration object containing the following fields:
`RpcResponse<object>` - RpcResponse JSON object with `value` field set to a JSON object including:

- `blockhash: <string>` - a Hash as base-58 encoded string
- `lastValidBlockHeight: <u64>` - last [block height](../../terminology.md#block-height) at which the blockhash will be valid
- `lastValidBlockHeight: <u64>` - last [block height](https://solana.com/docs/terminology#block-height) at which the blockhash will be valid

</CodeParams>

Expand Down
2 changes: 1 addition & 1 deletion docs/src/api/methods/_getSignatureStatuses.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import {

## getSignatureStatuses

Returns the statuses of a list of signatures. Each signature must be a [txid](/terminology#transaction-id), the first signature of a transaction.
Returns the statuses of a list of signatures. Each signature must be a [txid](https://solana.com/docs/terminology#transaction-id), the first signature of a transaction.

:::info
Unless the `searchTransactionHistory` configuration parameter is included,
Expand Down
4 changes: 2 additions & 2 deletions docs/src/api/methods/_sendTransaction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Before submitting, the following preflight checks are performed:
preflight commitment to avoid confusing behavior.

The returned signature is the first signature in the transaction, which
is used to identify the transaction ([transaction id](../../terminology.md#transaction-id)).
is used to identify the transaction ([transaction id](https://solana.com/docs/terminology#transaction-id)).
This identifier can be easily extracted from the transaction data before
submission.

Expand Down Expand Up @@ -88,7 +88,7 @@ Values: `base58` (_slow_, **DEPRECATED**), or `base64`.

### Result:

`<string>` - First Transaction Signature embedded in the transaction, as base-58 encoded string ([transaction id](../../terminology.md#transaction-id))
`<string>` - First Transaction Signature embedded in the transaction, as base-58 encoded string ([transaction id](https://solana.com/docs/terminology#transaction-id))

</CodeParams>

Expand Down
2 changes: 1 addition & 1 deletion docs/src/api/websocket/_signatureSubscribe.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ transaction signature, as base-58 encoded string
:::info

The transaction signature must be the first signature from the transaction (see
[transaction id](/terminology#transaction-id) for more details).
[transaction id](https://solana.com/docs/terminology#transaction-id) for more details).

:::

Expand Down
30 changes: 16 additions & 14 deletions docs/src/cli/deploy-a-program.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
title: Deploy a Program
---

Developers can deploy on-chain [programs](terminology.md#program) (often called
smart contracts elsewhere) with the Solana tools.
Developers can deploy on-chain
[programs](https://solana.com/docs/terminology#program) (often called smart
contracts elsewhere) with the Solana tools.

To learn about developing and executing programs on Solana, start with the
[intro to Solana programs](developing/intro/programs.md) and then dig into the
Expand Down Expand Up @@ -100,10 +101,10 @@ solana program deploy <PROGRAM_FILEPATH>

By default, programs are deployed to accounts that are twice the size of the
original deployment. Doing so leaves room for program growth in future
redeployments. But, if the initially deployed program is very small and then
later grows substantially, the redeployment may fail. To avoid this, specify
a `max_len` that is at least the size (in bytes) that the program is expected
to become (plus some wiggle room).
redeployments. But, if the initially deployed program is very small and then
later grows substantially, the redeployment may fail. To avoid this, specify a
`max_len` that is at least the size (in bytes) that the program is expected to
become (plus some wiggle room).

```bash
solana program deploy --max-len 200000 <PROGRAM_FILEPATH>
Expand All @@ -117,9 +118,9 @@ is locked up permanently.
### Resuming a failed deploy

If program deployment fails, there will be a hanging intermediate buffer account
that contains a non-zero balance. In order to recoup that balance you may
resume a failed deployment by providing the same intermediate buffer to a new
call to `deploy`.
that contains a non-zero balance. In order to recoup that balance you may resume
a failed deployment by providing the same intermediate buffer to a new call to
`deploy`.

Deployment failures will print an error message specifying the seed phrase
needed to recover the generated intermediate buffer's keypair:
Expand Down Expand Up @@ -158,8 +159,8 @@ Both program and buffer accounts can be closed and their lamport balances
transferred to a recipient's account.

If deployment fails there will be a left over buffer account that holds
lamports. The buffer account can either be used to [resume a
deploy](#resuming-a-failed-deploy) or closed.
lamports. The buffer account can either be used to
[resume a deploy](#resuming-a-failed-deploy) or closed.

The program or buffer account's authority must be present to close an account,
to list all the open program or buffer accounts that match the default
Expand Down Expand Up @@ -273,9 +274,10 @@ $ sha256sum extended.so dump.so
### Using an intermediary Buffer account

Instead of deploying directly to the program account, the program can be written
to an intermediary buffer account. Intermediary accounts can be useful for things
like multi-entity governed programs where the governing members fist verify the
intermediary buffer contents and then vote to allow an upgrade using it.
to an intermediary buffer account. Intermediary accounts can be useful for
things like multi-entity governed programs where the governing members fist
verify the intermediary buffer contents and then vote to allow an upgrade using
it.

```bash
solana program write-buffer <PROGRAM_FILEPATH>
Expand Down
8 changes: 6 additions & 2 deletions docs/src/cluster/commitments.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Commitment Status
description: "Processed, confirmed, and finalized. Learn the differences between the different commitment statuses on the Solana blockchain."
description:
"Processed, confirmed, and finalized. Learn the differences between the
different commitment statuses on the Solana blockchain."
keywords:
- processed
- confirmed
Expand All @@ -10,7 +12,9 @@ keywords:
- blockhash
---

The [commitment](./../terminology.md#commitment) metric gives clients a standard measure of the network confirmation for the block. Clients can then use this information to derive their own measures of commitment.
The [commitment](https://solana.com/docs/terminology#commitment) metric gives
clients a standard measure of the network confirmation for the block. Clients
can then use this information to derive their own measures of commitment.

There are three specific commitment statuses:

Expand Down
Loading