From d0d4d9b3d125ff8210c0b38bc772170361d6f4d5 Mon Sep 17 00:00:00 2001 From: Dan Albert Date: Fri, 17 Jul 2020 11:48:07 -0600 Subject: [PATCH] Fix 404 broken links (#11113) Co-authored-by: publish-docs.sh --- docs/docusaurus.config.js | 6 +++--- docs/sidebars.js | 5 +++-- docs/src/implemented-proposals/ed_overview/ed_mvp.md | 12 +++++++++++- .../{ed_cluster_economics.md => ed_overview.md} | 0 .../implemented-proposals/implemented-proposals.md | 9 +++++++++ docs/src/implemented-proposals/staking-rewards.md | 2 +- docs/src/pages/index.js | 2 +- docs/src/proposals/accepted-design-proposals.md | 11 +++++++++++ docs/src/proposals/accepted_design_proposals.md | 5 ----- docs/src/wallet-guide/cli.md | 4 ++-- 10 files changed, 41 insertions(+), 15 deletions(-) rename docs/src/implemented-proposals/ed_overview/{ed_cluster_economics.md => ed_overview.md} (100%) create mode 100644 docs/src/implemented-proposals/implemented-proposals.md create mode 100644 docs/src/proposals/accepted-design-proposals.md delete mode 100644 docs/src/proposals/accepted_design_proposals.md diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 9557b9fa96..6291c24637 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -21,12 +21,12 @@ module.exports = { position: "left", }, { - to: "apps/README", + to: "apps", label: "Developers", position: "left", }, { - to: "running-validator/README", + to: "running-validator", label: "Validators", position: "left", }, @@ -55,7 +55,7 @@ module.exports = { }, { label: "Tour de SOL", - to: "tour-de-sol/README", + to: "tour-de-sol", }, ], }, diff --git a/docs/sidebars.js b/docs/sidebars.js index f855b824a4..f44ff95d2f 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -111,11 +111,12 @@ module.exports = { Terminology: ["terminology"], History: ["history"], "Implemented Design Proposals": [ + "implemented-proposals/implemented-proposals", { type: "category", label: "Economic Design", items: [ - "implemented-proposals/ed_overview/ed_cluster_economics", + "implemented-proposals/ed_overview/ed_overview", { type: "category", label: "Validation Client Economics", @@ -153,7 +154,7 @@ module.exports = { "implemented-proposals/abi-management", ], "Accepted Design Proposals": [ - "proposals/accepted_design_proposals", + "proposals/accepted-design-proposals", "proposals/ledger-replication-to-implement", "proposals/optimistic-confirmation-and-slashing", "proposals/vote-signing-to-implement", diff --git a/docs/src/implemented-proposals/ed_overview/ed_mvp.md b/docs/src/implemented-proposals/ed_overview/ed_mvp.md index 0858c2a27d..a66974ebe3 100644 --- a/docs/src/implemented-proposals/ed_overview/ed_mvp.md +++ b/docs/src/implemented-proposals/ed_overview/ed_mvp.md @@ -4,7 +4,17 @@ title: Economic Design MVP **Subject to change.** -The preceding sections, outlined in the [Economic Design Overview](../README.md), describe a long-term vision of a sustainable Solana economy. Of course, we don't expect the final implementation to perfectly match what has been described above. We intend to fully engage with network stakeholders throughout the implementation phases \(i.e. pre-testnet, testnet, mainnet\) to ensure the system supports, and is representative of, the various network participants' interests. The first step toward this goal, however, is outlining a some desired MVP economic features to be available for early pre-testnet and testnet participants. Below is a rough sketch outlining basic economic functionality from which a more complete and functional system can be developed. +The preceding sections, outlined in the +[Economic Design Overview](ed_overview.md), +describe a long-term vision of a sustainable Solana economy. +Of course, we don't expect the final implementation to perfectly match what has +been described above. We intend to fully engage with network stakeholders +throughout the implementation phases \(i.e. pre-testnet, testnet, mainnet\) +to ensure the system supports, and is representative of, the various network +participants' interests. The first step toward this goal, however, is outlining +a some desired MVP economic features to be available for early pre-testnet and +testnet participants. Below is a rough sketch outlining basic economic +functionality from which a more complete and functional system can be developed. ## MVP Economic Features diff --git a/docs/src/implemented-proposals/ed_overview/ed_cluster_economics.md b/docs/src/implemented-proposals/ed_overview/ed_overview.md similarity index 100% rename from docs/src/implemented-proposals/ed_overview/ed_cluster_economics.md rename to docs/src/implemented-proposals/ed_overview/ed_overview.md diff --git a/docs/src/implemented-proposals/implemented-proposals.md b/docs/src/implemented-proposals/implemented-proposals.md new file mode 100644 index 0000000000..67007f7903 --- /dev/null +++ b/docs/src/implemented-proposals/implemented-proposals.md @@ -0,0 +1,9 @@ +--- +title: Implemented Design Proposals +--- + +The following architectural proposals have been accepted and implemented +by the Solana team. Any designs that may be subject to future change are noted +in the specific proposal page. +Design proposals that have been accepted but not yet implemented are found in +[Accepted Proposals](../proposals/accepted-design-proposals.md). diff --git a/docs/src/implemented-proposals/staking-rewards.md b/docs/src/implemented-proposals/staking-rewards.md index f9e4d456f3..f82d6594fe 100644 --- a/docs/src/implemented-proposals/staking-rewards.md +++ b/docs/src/implemented-proposals/staking-rewards.md @@ -52,6 +52,6 @@ Solana's trustless sense of time and ordering provided by its PoH data structure ## Penalties -As discussed in the [Economic Design](ed_overview/ed_cluster_economics.md) section, annual validator interest rates are to be specified as a function of total percentage of circulating supply that has been staked. The cluster rewards validators who are online and actively participating in the validation process throughout the entirety of their _validation period_. For validators that go offline/fail to validate transactions during this period, their annual reward is effectively reduced. +As discussed in the [Economic Design](ed_overview/ed_overview.md) section, annual validator interest rates are to be specified as a function of total percentage of circulating supply that has been staked. The cluster rewards validators who are online and actively participating in the validation process throughout the entirety of their _validation period_. For validators that go offline/fail to validate transactions during this period, their annual reward is effectively reduced. Similarly, we may consider an algorithmic reduction in a validator's active amount staked amount in the case that they are offline. I.e. if a validator is inactive for some amount of time, either due to a partition or otherwise, the amount of their stake that is considered ‘active’ \(eligible to earn rewards\) may be reduced. This design would be structured to help long-lived partitions to eventually reach finality on their respective chains as the % of non-voting total stake is reduced over time until a supermajority can be achieved by the active validators in each partition. Similarly, upon re-engaging, the ‘active’ amount staked will come back online at some defined rate. Different rates of stake reduction may be considered depending on the size of the partition/active set. diff --git a/docs/src/pages/index.js b/docs/src/pages/index.js index 2c97cd5b83..5f53215204 100644 --- a/docs/src/pages/index.js +++ b/docs/src/pages/index.js @@ -59,7 +59,7 @@ const features = [ }, // // { // title: <>Understand Our Economic Design, - // imageUrl: "implemented-proposals/ed_overview/ed_cluster_economics", + // imageUrl: "implemented-proposals/ed_overview/ed_overview", // description: ( // <> // Solana's Economic Design provides a scalable blueprint for long term diff --git a/docs/src/proposals/accepted-design-proposals.md b/docs/src/proposals/accepted-design-proposals.md new file mode 100644 index 0000000000..98f197da4e --- /dev/null +++ b/docs/src/proposals/accepted-design-proposals.md @@ -0,0 +1,11 @@ +--- +title: Accepted Design Proposals +--- + +The following architectural proposals have been accepted by the Solana team, +but are not yet fully implemented. +The proposals may be implemented as described, implemented differently as +issues in the designs become evident, or not implemented at all. +If implemented, the proposal will be moved to +[Implemented Proposals](../implemented-proposals/implemented-proposals.md) +and the details will be added to relevant sections of the docs. diff --git a/docs/src/proposals/accepted_design_proposals.md b/docs/src/proposals/accepted_design_proposals.md deleted file mode 100644 index 0b42fbe27a..0000000000 --- a/docs/src/proposals/accepted_design_proposals.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: Accepted Design Proposals ---- - -The following architectural proposals have been accepted by the Solana team, but are not yet fully implemented. The proposals may be implemented as described, implemented differently as issues in the designs become evident, or not implemented at all. If implemented, the proposal will be moved to [Implemented Proposals](../implemented-proposals/README.md) and the details will be added to relevant sections of the docs. diff --git a/docs/src/wallet-guide/cli.md b/docs/src/wallet-guide/cli.md index 498b207aea..46defdee9a 100644 --- a/docs/src/wallet-guide/cli.md +++ b/docs/src/wallet-guide/cli.md @@ -30,7 +30,7 @@ keypairs are stored on your computer as files, a skilled hacker with physical access to your computer may be able to access it. Using an encrypted hard drive, such as FileVault on MacOS, minimizes that risk. -[File System Wallet](../file-system-wallet/README.md") +[File System Wallet](file-system-wallet.md) ## Paper Wallet @@ -64,4 +64,4 @@ security and convenience for cryptocurrencies. It effectively automates the process of offline signing while retaining nearly all the convenience of a file system wallet. -[Hardware Wallets]("../hardware-wallet/README.md") +[Hardware Wallets](hardware-wallets.md)