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

Improvements to Documentation Clarity and Accuracy #3502

Merged
merged 10 commits into from
Dec 11, 2023
Merged

Improvements to Documentation Clarity and Accuracy #3502

merged 10 commits into from
Dec 11, 2023

Conversation

joaolago1113
Copy link
Contributor

I've made a series of updates to the project documentation to enhance clarity and correct minor typographical errors. Below is a summary of the changes:

  1. Fix Typos in Various Sections:

    • Corrected a typo in the 'Algorithms and Protocols' section.
    • Addressed a typo in the NOTE section of 'flow-encryption/dkg.md'.
    • Fixed a typo in the 'Maintaining protobuf specs' section.
    • Corrected a typographical error in the installation instructions.
    • Addressed a typo in the 'Privacy for Market-Takers' section.
    • Fixed an orthographic mistake in the Rustdoc README file.
    • Corrected a typo in the governance documentation.
    • Addressed a typo in the IBC protocol documentation.
  2. Enhance Phrasing and Grammar:

    • Improved phrasing in the 'Updating your validator' section.
    • Corrected redundant phrasing in the 'batching_flows.md' document.

In summary, these edits make our docs clearer and more precise, enhancing usability for all.

Copy link
Member

@hdevalence hdevalence left a comment

Choose a reason for hiding this comment

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

Awesome, thanks!

@hdevalence hdevalence merged commit 4d2ff4d into penumbra-zone:main Dec 11, 2023
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants