Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhancements to Solana's Documentations for Better Clarity #34386

Merged
merged 6 commits into from
Dec 12, 2023
Merged

Enhancements to Solana's Documentations for Better Clarity #34386

merged 6 commits into from
Dec 12, 2023

Conversation

joaolago1113
Copy link
Contributor

I've gone through some of the documentation and noticed a few spots where a little polishing could really enhance the reader's experience. With that in mind, I've made a handful of edits that I think will make a difference. Here's a quick rundown:

  1. Get Started Overview (commit 78bf40b): I tweaked the introduction a bit for smoother reading and fixed a small typo.
  2. Validator Runtime (commit cdd5070): Spotted a few grammatical hiccups and clarified some points around transaction execution.
  3. Validator Gossip (commit d2f1dbd): Ironed out some grammatical wrinkles to make things clearer.
  4. Transaction Fees (commit 6428e96): Updated a hyperlink for better navigation and corrected a couple of spelling errors.
  5. Staking (commit ff9c493): Added a missing word in the 'Delegate your Stake' section to guide users better.
  6. Metrics and Networking (commit e3a0b5a): Fixed a few typos and fine-tuned the language for better understanding.
  7. Geyser Plugin Interface (commit e7688b5): Adjusted some grammatical details for consistency and clarity.
  8. CI Setup Instructions (commit 9bd82d7): Caught and corrected a typo in the setup instructions.
  9. Security Incident Response Process (commit 3b9665c): Made a small grammatical correction for clearer understanding.

Thanks for all the incredible work you do, and for considering these suggestions!

@mergify mergify bot added community Community contribution need:merge-assist labels Dec 10, 2023
@mergify mergify bot requested a review from a team December 10, 2023 01:40
Copy link
Contributor

@CriesofCarrots CriesofCarrots left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, this mostly looks good. One quibble.

docs/src/getstarted/overview.md Outdated Show resolved Hide resolved
…luralization, and singular form in database reference
…iroment' to 'environment', correct 'reults' to 'results' in Ping Results section, and change 'engress' to 'egress' in CUDA section.
Correct subject-verb agreement in transaction balance description and clarify execution of instructions in a transaction.
@CriesofCarrots
Copy link
Contributor

CriesofCarrots commented Dec 11, 2023

Some of these docs were just moved to a different repo. Fixes made in this PR to those files should be reflected here: solana-foundation/developer-content#34

Copy link
Contributor

@nickfrosty nickfrosty left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All changes look good!

@nickfrosty nickfrosty merged commit 05dae59 into solana-labs:master Dec 12, 2023
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community Community contribution need:merge-assist
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants