diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8b42c20231..e3daae2cef 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -89,24 +89,23 @@ understood. Avoid introducing new 3-letter terms, which can be confused with 3-l [Terms currently in use](book/src/terminology.md) -Proposing architectural changes +Design Proposals --- Solana's architecture is described by a book generated from markdown files in the `book/src/` directory, maintained by an *editor* (currently @garious). To -change the architecture, you'll need to at least propose a change the content -under the [Proposed -Changes](https://solana-labs.github.io/book-edge/proposals.html) chapter. Here's -the full process: +add a design proposal, you'll need to at least propose a change the content +under the [Accepted Design +Proposals](https://solana-labs.github.io/book-edge/proposals.html) chapter. +Here's the full process: -1. Propose to a change to the architecture by creating a PR that adds a - markdown document to the directory `book/src/` and references it from the - [table of contents](book/src/SUMMARY.md). Add the editor and any relevant - *maintainers* to the PR review. +1. Propose a design by creating a PR that adds a markdown document to the + directory `book/src/` and references it from the [table of + contents](book/src/SUMMARY.md). Add any relevant *maintainers* to the PR review. 2. The PR being merged indicates your proposed change was accepted and that the - editor and maintainers support your plan of attack. + maintainers support your plan of attack. 3. Submit PRs that implement the proposal. When the implementation reveals the - need for tweaks to the architecture, be sure to update the proposal and have + need for tweaks to the proposal, be sure to update the proposal and have that change reviewed by the same people as in step 1. -4. Once the implementation is complete, the editor will then work to integrate - the document into the book. +4. Once the implementation is complete, submit a PR that moves the link from + the Accepted Proposals to the Implemented Proposals section. diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md index 1240a168fd..02b347f62b 100644 --- a/book/src/SUMMARY.md +++ b/book/src/SUMMARY.md @@ -34,15 +34,14 @@ - [JavaScript API](javascript-api.md) - [solana-wallet CLI](wallet.md) -- [Proposed Architectural Changes](proposals.md) +- [Accepted Design Proposals](proposals.md) - [Ledger Replication](ledger-replication-to-implement.md) - [Secure Vote Signing](vote-signing-to-implement.md) - [Staking Rewards](staking-rewards.md) - - [Passive Staking Delegation and Rewards](passive-stake-delegation-and-rewards.md) + - [Passive Stake Delegation and Rewards](passive-stake-delegation-and-rewards.md) - [Fork Selection](fork-selection.md) - [Reliable Vote Transmission](reliable-vote-transmission.md) - [Persistent Account Storage](persistent-account-storage.md) - - [Leader to Leader Transition](leader-leader-transition.md) - [Cluster Economics](ed_overview.md) - [Validation-client Economics](ed_validation_client_economics.md) - [State-validation Protocol-based Rewards](ed_vce_state_validation_protocol_based_rewards.md) @@ -55,6 +54,9 @@ - [Economic Sustainability](ed_economic_sustainability.md) - [Attack Vectors](ed_attack_vectors.md) - [References](ed_references.md) - - [Leader-to-Validator Transition](leader-validator-transition.md) - [Cluster Test Framework](cluster-test-framework.md) - [Testing Programs](testing-programs.md) + +- [Implemented Design Proposals](implemented-proposals.md) + - [Leader-to-Leader Transition](leader-leader-transition.md) + - [Leader-to-Validator Transition](leader-validator-transition.md) diff --git a/book/src/implemented-proposals.md b/book/src/implemented-proposals.md new file mode 100644 index 0000000000..924f54c16d --- /dev/null +++ b/book/src/implemented-proposals.md @@ -0,0 +1,3 @@ +# Implemented Design Proposals + +The following design proposals are fully implemented.