ffeac298a2
* 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 <mvines@gmail.com> Co-authored-by: Ryan Shea <rmshea@users.noreply.github.com> Co-authored-by: publish-docs.sh <maintainers@solana.com>
174 lines
5.9 KiB
JavaScript
174 lines
5.9 KiB
JavaScript
module.exports = {
|
|
docs: {
|
|
Introduction: ["introduction"],
|
|
"Wallet Guide": [
|
|
"wallet-guide/README",
|
|
{
|
|
type: "category",
|
|
label: "App Wallets",
|
|
items: [
|
|
"wallet-guide/apps",
|
|
"wallet-guide/trust-wallet",
|
|
"wallet-guide/ledger-live",
|
|
],
|
|
},
|
|
{
|
|
type: "category",
|
|
label: "Command-line Wallets",
|
|
items: [
|
|
"wallet-guide/cli",
|
|
{
|
|
type: "category",
|
|
label: "Paper Wallets",
|
|
items: ["paper-wallet/README", "paper-wallet/paper-wallet-usage"],
|
|
},
|
|
{
|
|
type: "category",
|
|
label: "Hardware Wallets",
|
|
items: ["hardware-wallets/README", "hardware-wallets/ledger"],
|
|
},
|
|
"file-system-wallet/README",
|
|
],
|
|
},
|
|
"wallet-guide/support",
|
|
],
|
|
"Command Line Guide": [
|
|
"cli/README",
|
|
"cli/install-solana-cli-tools",
|
|
"cli/conventions",
|
|
"cli/choose-a-cluster",
|
|
"cli/transfer-tokens",
|
|
"cli/manage-stake-accounts",
|
|
"offline-signing/README",
|
|
"offline-signing/durable-nonce",
|
|
],
|
|
"Solana Clusters": ["clusters"],
|
|
"Develop Applications": [
|
|
"apps/README",
|
|
"apps/rent",
|
|
"apps/webwallet",
|
|
"apps/tictactoe",
|
|
"apps/drones",
|
|
"transaction",
|
|
"apps/jsonrpc-api",
|
|
"apps/javascript-api",
|
|
"apps/builtins/README",
|
|
],
|
|
"Integration Guides": ["integrations/exchange"],
|
|
"Run a Validator": [
|
|
"running-validator/README",
|
|
"running-validator/validator-reqs",
|
|
"running-validator/validator-start",
|
|
"running-validator/validator-stake",
|
|
"running-validator/validator-monitor",
|
|
"running-validator/validator-info",
|
|
"running-validator/validator-troubleshoot",
|
|
],
|
|
"Tour de SOL": [
|
|
"tour-de-sol/README",
|
|
"tour-de-sol/useful-links",
|
|
{
|
|
type: "category",
|
|
label: "Registration",
|
|
items: [
|
|
"tour-de-sol/registration/how-to-register",
|
|
"tour-de-sol/registration/terms-of-participation",
|
|
"tour-de-sol/registration/rewards",
|
|
"tour-de-sol/registration/confidentiality",
|
|
"tour-de-sol/registration/validator-registration-and-rewards-faq",
|
|
],
|
|
},
|
|
{
|
|
type: "category",
|
|
label: "Participation",
|
|
items: [
|
|
"tour-de-sol/participation/validator-technical-requirements",
|
|
"tour-de-sol/participation/validator-public-key-registration",
|
|
"tour-de-sol/participation/steps-to-create-a-validator",
|
|
],
|
|
},
|
|
"tour-de-sol/submitting-bugs",
|
|
],
|
|
"Benchmark a Cluster": ["cluster/bench-tps", "cluster/performance-metrics"],
|
|
"Solana's Architecture": [
|
|
"cluster/README",
|
|
"cluster/synchronization",
|
|
"cluster/leader-rotation",
|
|
"cluster/fork-generation",
|
|
"cluster/managing-forks",
|
|
"cluster/turbine-block-propagation",
|
|
"cluster/vote-signing",
|
|
"cluster/stake-delegation-and-rewards",
|
|
],
|
|
"Anatomy of a Validator": [
|
|
"validator/README",
|
|
"validator/tpu",
|
|
"validator/tvu",
|
|
"validator/blockstore",
|
|
"validator/gossip",
|
|
"validator/runtime",
|
|
],
|
|
Terminology: ["terminology"],
|
|
History: ["history"],
|
|
"Implemented Design Proposals": [
|
|
{
|
|
type: "category",
|
|
label: "Economic Design",
|
|
items: [
|
|
"implemented-proposals/ed_overview/README",
|
|
{
|
|
type: "category",
|
|
label: "Validation Client Economics",
|
|
items: [
|
|
"implemented-proposals/ed_overview/ed_validation_client_economics/README",
|
|
"implemented-proposals/ed_overview/ed_validation_client_economics/ed_vce_state_validation_protocol_based_rewards",
|
|
"implemented-proposals/ed_overview/ed_validation_client_economics/ed_vce_state_validation_transaction_fees",
|
|
"implemented-proposals/ed_overview/ed_validation_client_economics/ed_vce_validation_stake_delegation",
|
|
],
|
|
},
|
|
"implemented-proposals/ed_overview/ed_storage_rent_economics",
|
|
"implemented-proposals/ed_overview/ed_economic_sustainability",
|
|
"implemented-proposals/ed_overview/ed_mvp",
|
|
"implemented-proposals/ed_overview/ed_references",
|
|
],
|
|
},
|
|
"implemented-proposals/transaction-fees",
|
|
"implemented-proposals/tower-bft",
|
|
"implemented-proposals/leader-leader-transition",
|
|
"implemented-proposals/leader-validator-transition",
|
|
"implemented-proposals/persistent-account-storage",
|
|
"implemented-proposals/reliable-vote-transmission",
|
|
"implemented-proposals/repair-service",
|
|
"implemented-proposals/testing-programs",
|
|
"implemented-proposals/readonly-accounts",
|
|
"implemented-proposals/embedding-move",
|
|
"implemented-proposals/staking-rewards",
|
|
"implemented-proposals/rent",
|
|
"implemented-proposals/durable-tx-nonces",
|
|
"implemented-proposals/validator-timestamp-oracle",
|
|
"implemented-proposals/commitment",
|
|
"implemented-proposals/snapshot-verification",
|
|
"implemented-proposals/cross-program-invocation",
|
|
"implemented-proposals/program-derived-addresses",
|
|
"implemented-proposals/abi-management",
|
|
],
|
|
"Accepted Design Proposals": [
|
|
"proposals/README",
|
|
"proposals/ledger-replication-to-implement",
|
|
"proposals/optimistic-confirmation-and-slashing",
|
|
"proposals/vote-signing-to-implement",
|
|
"proposals/cluster-test-framework",
|
|
"proposals/validator-proposal",
|
|
"proposals/simple-payment-and-state-verification",
|
|
"proposals/interchain-transaction-verification",
|
|
"proposals/snapshot-verification",
|
|
"proposals/bankless-leader",
|
|
"proposals/slashing",
|
|
"proposals/tick-verification",
|
|
"proposals/block-confirmation",
|
|
"proposals/rust-clients",
|
|
"proposals/optimistic_confirmation",
|
|
],
|
|
},
|
|
};
|