[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]>
solana-labs · Dec 11, 2023 · 676e80c · 676e80c
1 parent 4b76232
commit 676e80c
Show file tree

Hide file tree

Showing 237 changed files with 1,924 additions and 20,064 deletions.
diff --git a/docs/.prettierignore b/docs/.prettierignore
@@ -2,6 +2,3 @@
 build
 html
 static
-
-# prettier interferes with the json response too much
-src/developing/clients/jsonrpc-api.md
diff --git a/docs/README.md b/docs/README.md
@@ -1,11 +1,11 @@
-# Solana Docs Readme
+# Solana Validator Docs Readme
 
-Solana's Docs are built using [Docusaurus v2](https://v2.docusaurus.io/) with `npm`.
+This validator's docs are built using [Docusaurus v2](https://v2.docusaurus.io/) with `npm`.
 Static content delivery is handled using `vercel`.
 
 ## Local Development
 
-To set up the Solana Docs site locally:
+To set up the Solana Validator Docs site locally:
 
 - install dependencies using `npm`
 - build locally via `./build.sh`
@@ -30,7 +30,7 @@ The build script generates static content into the `build` directory and can be
 ./build.sh
 ```
 
-Running this build script requires **Docker**, and will auto fetch the [solanalabs/rust](https://hub.docker.com/r/solanalabs/rust) image from Docker hub to compile the desired version of the [Solana CLI](https://docs.solana.com/cli) from source.
+Running this build script requires **Docker**, and will auto fetch the [solanalabs/rust](https://hub.docker.com/r/solanalabs/rust) image from Docker hub to compile the desired version of the [Solana CLI](https://docs.solanalabs.com/cli) from source.
 
 This build script will also:
 
@@ -75,9 +75,9 @@ The docs are built and published in Travis CI with the `./build.sh` script. On e
 
 In each post-commit build, docs are built and published using `vercel` to their respective domain depending on the build branch.
 
-- Master branch docs are published to `edge.docs.solana.com`
-- Beta branch docs are published to `beta.docs.solana.com`
-- Latest release tag docs are published to `docs.solana.com`
+- Master branch docs are published to `edge.docs.solanalabs.com`
+- Beta branch docs are published to `beta.docs.solanalabs.com`
+- Latest release tag docs are published to `docs.solanalabs.com`
 
 ## Common Issues
 

diff --git a/docs/build-cli-usage.sh b/docs/build-cli-usage.sh
@@ -15,7 +15,7 @@ out=${1:-src/cli/usage.md}
 # load the usage file's header
 cat src/cli/.usage.md.header > "$out"
 
-# Skip generating the usage doc for non deployment commits of the docs
+# Skip generating the detailed usage doc for non deployment commits of the docs
 if [[ -n $CI ]]; then
   if [[ $CI_BRANCH != $EDGE_CHANNEL* ]] && [[ $CI_BRANCH != $BETA_CHANNEL* ]] && [[ $CI_BRANCH != $STABLE_CHANNEL* ]]; then
     echo "**NOTE:** The usage doc is only auto-generated during full production deployments of the docs"

diff --git a/docs/components/CodeDocBlock.jsx b/docs/components/CodeDocBlock.jsx
diff --git a/docs/components/HomeCtaLinks.jsx b/docs/components/HomeCtaLinks.jsx
@@ -6,23 +6,23 @@ export default function HomeCtaLinks() {
     <div className="container">
       <div className="row cards__container">
         <Card
-          to="developers"
+          to="https://solana.com/developers"
           header={{
             label: "Developers",
             translateId: "cta-developers",
           }}
         />
 
         <Card
-          to="running-validator"
+          to="operations"
           header={{
-            label: "Validators",
+            label: "Operate a Validator",
             translateId: "cta-validators",
           }}
         />
 
         <Card
-          to="cluster/overview"
+          to="clusters"
           header={{
             label: "Architecture",
             translateId: "cta-architecture",

diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
@@ -1,10 +1,10 @@
 const math = require("remark-math");
 const katex = require("rehype-katex");
 module.exports = {
-  title: "Solana Docs",
+  title: "Solana Validator",
   tagline:
     "Solana is an open source project implementing a new, high-performance, permissionless blockchain.",
-  url: "https://docs.solana.com",
+  url: "https://docs.solanalabs.com",
   baseUrl: "/",
   favicon: "img/favicon.ico",
   organizationName: "solana-labs", // Usually your GitHub org/user name.
@@ -55,43 +55,29 @@ module.exports = {
         srcDark: "img/logo-horizontal-dark.svg",
       },
       items: [
-        {
-          to: "introduction",
-          label: "Learn",
-          position: "left",
-        },
-        {
-          to: "cluster/overview",
-          label: "Architecture",
-          position: "left",
-        },
         {
           to: "cli",
           label: "CLI",
           position: "left",
         },
         {
-          to: "/developers",
-          label: "Developers",
+          to: "architecture",
+          label: "Architecture",
           position: "left",
         },
         {
-          to: "running-validator",
-          label: "Validators",
+          to: "operations",
+          label: "Operating a Validator",
           position: "left",
         },
         {
           label: "More",
           position: "left",
           items: [
-            { label: "Terminology", to: "terminology" },
-            { label: "Staking", to: "staking" },
-            { label: "Integrations", to: "integrations/exchange" },
-            { label: "Economics", to: "economics_overview" },
             { label: "Proposals", to: "proposals" },
             {
               href: "https://spl.solana.com",
-              label: "Solana Program Library »",
+              label: "Solana Program Library",
             },
           ],
         },
@@ -129,24 +115,20 @@ module.exports = {
           title: "Documentation",
           items: [
             {
-              label: "Learn",
-              to: "introduction",
-            },
-            {
-              label: "Developers",
-              to: "/developers",
+              label: "Developers »",
+              href: "https://solana.com/developers",
             },
             {
-              label: "Validators",
-              to: "running-validator",
+              label: "Running a Validator",
+              to: "operations",
             },
             {
               label: "Command Line",
               to: "cli",
             },
             {
               label: "Architecture",
-              to: "cluster/overview",
+              to: "architecture",
             },
           ],
         },
@@ -167,7 +149,7 @@ module.exports = {
             },
             {
               label: "Twitter »",
-              href: "https://twitter.com/solana",
+              href: "https://solana.com/twitter",
             },
             {
               label: "Forum »",
@@ -179,12 +161,12 @@ module.exports = {
           title: "Resources",
           items: [
             {
-              label: "Proposals",
-              to: "proposals",
+              label: "Terminology »",
+              href: "https://solana.com/docs/terminology",
             },
             {
-              label: "Integrations",
-              to: "integrations/exchange",
+              label: "Proposals",
+              to: "proposals",
             },
             {
               href: "https://spl.solana.com",
@@ -193,7 +175,7 @@ module.exports = {
           ],
         },
       ],
-      copyright: `Copyright © ${new Date().getFullYear()} Solana Foundation`,
+      copyright: `Copyright © ${new Date().getFullYear()} Solana Labs`,
     },
   },
   presets: [
@@ -202,7 +184,7 @@ module.exports = {
       {
         docs: {
           path: "src",
-          breadcrumbs: false,
+          breadcrumbs: true,
           routeBasePath: "/",
           sidebarPath: require.resolve("./sidebars.js"),
           remarkPlugins: [math],
@@ -212,11 +194,11 @@ module.exports = {
           customCss: require.resolve("./src/css/custom.css"),
         },
         // Google Analytics are only active in prod
-        gtag: {
-          // this GA code is safe to be published
-          trackingID: "G-94WS0LRZRS",
-          anonymizeIP: true,
-        },
+        // gtag: {
+        // this GA code is safe to be published
+        // trackingID: "",
+        // anonymizeIP: true,
+        // },
       },
     ],
   ],