From 14dcaaee6cf39996c76c898444abfff1738a3429 Mon Sep 17 00:00:00 2001 From: Raj Gokal Date: Thu, 6 Aug 2020 12:19:35 -0700 Subject: [PATCH] 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 --- docs/docusaurus.config.js | 10 +++++ docs/sidebars.js | 91 ++++++++++++++++++++++++++------------- docs/src/history.md | 2 +- docs/src/pages/index.js | 4 +- 4 files changed, 73 insertions(+), 34 deletions(-) diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index a34dfbb3c..6f12013ce 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -30,6 +30,16 @@ module.exports = { label: "Validate", position: "left", }, + { + to: "integrations/exchange", + label: "Integrate", + position: "left", + }, + { + to: "cluster/overview", + label: "Learn", + position: "left", + }, { href: "https://discordapp.com/invite/pquxPsq", label: "Chat", diff --git a/docs/sidebars.js b/docs/sidebars.js index e416418ae..7d4a4cc62 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -1,7 +1,11 @@ module.exports = { docs: { - "Introduction": ["introduction"], - "Wallet Guide": [ + "About": [ + "introduction", + "terminology", + "history", + ], + "Wallets": [ "wallet-guide", { type: "category", @@ -28,11 +32,11 @@ module.exports = { }, "wallet-guide/support", ], - "Staking Guide": [ + "Staking": [ "staking", "staking/stake-accounts", ], - "Command Line Guide": [ + "Command Line": [ "cli", "cli/install-solana-cli-tools", "cli/conventions", @@ -43,8 +47,7 @@ module.exports = { "offline-signing", "offline-signing/durable-nonce", ], - "Solana Clusters": ["clusters"], - "Develop Applications": [ + "Developing": [ "apps", "apps/rent", "apps/hello-world", @@ -56,8 +59,8 @@ module.exports = { "apps/javascript-api", "apps/builtins", ], - "Integration Guides": ["integrations/exchange"], - "Run a Validator": [ + "Integrating": ["integrations/exchange"], + "Validating": [ "running-validator", "running-validator/validator-reqs", "running-validator/validator-start", @@ -65,12 +68,13 @@ module.exports = { "running-validator/validator-stake", "running-validator/validator-monitor", "running-validator/validator-info", - "running-validator/validator-troubleshoot", - ], - "Tour de SOL": [ - "tour-de-sol", { type: "category", + label: "Incenvitized Testnet", + items: [ + "tour-de-sol", + { + type: "category", label: "Registration", items: [ "tour-de-sol/registration/how-to-register", @@ -91,10 +95,21 @@ module.exports = { }, "tour-de-sol/useful-links", "tour-de-sol/submitting-bugs", + ], + }, + "running-validator/validator-troubleshoot", ], - "Benchmark a Cluster": ["cluster/bench-tps", "cluster/performance-metrics"], - "Solana's Architecture": [ - "cluster/overview", + "Clusters": [ + "clusters", + "cluster/bench-tps", + "cluster/performance-metrics" + ], + "Architecture": [ + { + type: "category", + label: "Cluster", + items: [ + "cluster/overview", "cluster/synchronization", "cluster/leader-rotation", "cluster/fork-generation", @@ -102,19 +117,27 @@ module.exports = { "cluster/turbine-block-propagation", "cluster/vote-signing", "cluster/stake-delegation-and-rewards", - ], - "Anatomy of a Validator": [ - "validator/anatomy", - "validator/tpu", - "validator/tvu", - "validator/blockstore", - "validator/gossip", - "validator/runtime", - ], - Terminology: ["terminology"], - History: ["history"], - "Implemented Design Proposals": [ - "implemented-proposals/implemented-proposals", + ], + }, + { + type: "category", + label: "Validator", + items: [ + "validator/anatomy", + "validator/tpu", + "validator/tvu", + "validator/blockstore", + "validator/gossip", + "validator/runtime", + ], + }, + ], + "Design Proposals": [ + { + type: "category", + label: "Implemented", + items: [ + "implemented-proposals/implemented-proposals", { type: "category", label: "Economic Design", @@ -154,9 +177,13 @@ module.exports = { "implemented-proposals/cross-program-invocation", "implemented-proposals/program-derived-addresses", "implemented-proposals/abi-management", - ], - "Accepted Design Proposals": [ - "proposals/accepted-design-proposals", + ], + }, + { + type: "category", + label: "Accepted", + items: [ + "proposals/accepted-design-proposals", "proposals/ledger-replication-to-implement", "proposals/optimistic-confirmation-and-slashing", "proposals/vote-signing-to-implement", @@ -173,6 +200,8 @@ module.exports = { "proposals/optimistic_confirmation", "proposals/embedding-move", "proposals/rip-curl", + ] + }, ], }, }; diff --git a/docs/src/history.md b/docs/src/history.md index a164996ac..608afd301 100644 --- a/docs/src/history.md +++ b/docs/src/history.md @@ -1,5 +1,5 @@ --- -title: History of the Solana Codebase +title: History --- In November of 2017, Anatoly Yakovenko published a whitepaper describing Proof diff --git a/docs/src/pages/index.js b/docs/src/pages/index.js index 06098ca37..4b8472194 100644 --- a/docs/src/pages/index.js +++ b/docs/src/pages/index.js @@ -13,13 +13,13 @@ const features = [ description: <>Get started building your decentralized app or marketplace., }, { - title: <>✅ Run a Validator Node, + title: <>🎛 Run a Validator Node, imageUrl: "running-validator", description: <>Validate transactions, secure the network, and earn rewards., }, { title: <>🏛 Create an SPL Token, - imageUrl: "tour-de-sol", + imageUrl: "https://spl.solana.com/token", description: ( <> Launch your own SPL Token, Solana's equivalent of ERC-20.