Skip to content

Commit

Permalink
Documentation Enhancements for Clarity and Accuracy in Solana Project (
Browse files Browse the repository at this point in the history
…#5999)

* Fix typo in DAO Wallet section: change 'sill' to 'still'

* Fix typo in 'Governance UI' and 'Build Locally' sections

* Fixed grammatical errors and typo in documentation: Added 'the' before 'Solana blockchain', changed 'uses open/close architecture' to 'uses an open/close architecture', and corrected 'belows' to 'below'.

* fix typo in SPL Noop Rust SDK section

* Fix typo in Twisted ElGamal Encryption section

* Revert "Fixed grammatical errors and typo in documentation: Added 'the' before 'Solana blockchain', changed 'uses open/close architecture' to 'uses an open/close architecture', and corrected 'belows' to 'below'."

This reverts commit b018e1f.

* fixed grammatical errors and typo in documentation: Added 'the' before 'Solana blockchain' and corrected 'belows' to 'below'.
  • Loading branch information
joaolago1113 authored Dec 17, 2023
1 parent 8e9dc13 commit ef44df9
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion account-compression/programs/noop/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# SPL Noop Rust SDK

This is crate provides a wrapper for invoking `spl-noop`, which does nothing.
This crate provides a wrapper for invoking `spl-noop`, which does nothing.
It's primary use is circumventing log truncation when emitting application data by `invoke`-ing `spl-noop` with event data.

`spl-noop` and this crate's implementation are targeted towards supporting [account-compression](https://github.com/solana-labs/solana-program-library/tree/master/account-compression) and may be subject to change.
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ $ npm install

### Local Development

This command starts a local development server and open up a browser window.
This command starts a local development server and opens up a browser window.
Most changes are reflected live without having to restart the server.

```
Expand Down
2 changes: 1 addition & 1 deletion docs/src/confidential-token/deep-dive/encryption.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ ElGamal encryption scheme where a ciphertext is divided into two components:
- A Pedersen commitment of the encrypted message. This component is independent
of the public key.
- A "decryption handle" that binds the encryption randomness with respect to a
specific ElGamal public key. This component is independent of the actually
specific ElGamal public key. This component is independent of the actual
encrypted message.

The structure of the twisted ElGamal ciphertexts simplifies their design of some
Expand Down
2 changes: 1 addition & 1 deletion docs/src/token-2022/extensions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ accounts through an extension model.
This guide explains all of the available extensions, along with some examples of
how to use them.

Please see the [Token-2022 Introduction](../token-2022) more general information
Please see the [Token-2022 Introduction](../token-2022) for more general information
about Token-2022 and the concept of extensions.

## Setup
Expand Down
2 changes: 1 addition & 1 deletion governance/NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ A DAO wallet is 1) PDA with no data, 2) derived from its governance account and

If the intention is to manage a program, you should use the DAO wallet as the admin auth in your program

*Note: as of 2022-09-17 the UI is not up-to-date and it is sill allowing users to create the deprecated asset specific governances.*
*Note: as of 2022-09-17 the UI is not up-to-date and it is still allowing users to create the deprecated asset specific governances.*

### Signing transactions: Use the DAO Wallet

Expand Down
6 changes: 3 additions & 3 deletions governance/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# SPL Governance

SPL Governance is a program the chief purpose of which is to provide core building blocks and primitives to create
Decentralized Autonomous Organizations (DAOs) on Solana blockchain.
Decentralized Autonomous Organizations (DAOs) on the Solana blockchain.

The program is DAO type and asset type agnostic and can be used to build any type of DAOs
which can own and manage any type of assets.
Expand Down Expand Up @@ -56,7 +56,7 @@ There are two UIs available which showcase the programs capabilities:

It's a good starting point for developers to learn about the program and interact with it

- [Governance UI](https://github.com/solana-labs/governance-ui) project build together
- [Governance UI](https://github.com/solana-labs/governance-ui) project built together
with the [MNGO](https://mango.markets/) team: [governance-ui](https://realms.today)

This is advanced, user friendly and tasks oriented UI used by most of the existing DAOs on Solana
Expand All @@ -73,7 +73,7 @@ Discord server: [spl-governance-discord](https://discord.gg/VsPbrK2hJk)

## Program Accounts

The diagram belows shows an illustrative configuration of the program accounts when used to control upgrades
The diagram below shows an illustrative configuration of the program accounts when used to control upgrades
of multiple programs through proposals

![Accounts diagram](./resources/governance-accounts.jpg)
Expand Down

0 comments on commit ef44df9

Please sign in to comment.