Skip to content

docs: Fixing typos and improving sentence clarity Update README.md#499

Merged
TheDZhon merged 1 commit intolidofinance:mainfrom
voronor:patch-1
Dec 30, 2024
Merged

docs: Fixing typos and improving sentence clarity Update README.md#499
TheDZhon merged 1 commit intolidofinance:mainfrom
voronor:patch-1

Conversation

@voronor
Copy link
Copy Markdown
Contributor

@voronor voronor commented Dec 28, 2024

I’ve corrected several typographical and grammatical errors in the documentation to improve clarity and accuracy. The key changes include fixing capitalization issues with "GitHub", adding necessary articles like "the", and improving sentence structure for better readability. Here's a summary of the changes:

  • "hosted via Github Pages from branch gh-pages of this repository." → "hosted via GitHub Pages from the gh-pages branch of this repository."
  • "Documentation pages stored in /docs folder." → "Documentation pages are stored in the /docs folder."
  • "The appearance of sidebar controlled manually via sidebars.js file." → "The appearance of the sidebar is controlled manually via the sidebars.js file."
  • "By default new added pages don't added to sidebar automatically." → "By default, newly added pages are not added to the sidebar automatically."
  • "For example to add new page faq.md as the last item of sidebar we need modify sidebar.js next way:" → "For example, to add a new page faq.md as the last item of the sidebar, we need to modify sidebar.js in the following way:"
  • "Build and deploy happens automatically when pull request is merged to mainbranch or someone pushes to main branch directly." → "Build and deployment happen automatically when a pull request is merged to the main branch or someone pushes to the main branch directly."
  • "To build documentation locally and push built version to the gh-pages branch use next command:" → "To build the documentation locally and push the built version to the gh-pages branch, use the following command:"

Thanks for Lido!

@voronor voronor requested a review from a team as a code owner December 28, 2024 09:10
Copy link
Copy Markdown
Contributor

@TheDZhon TheDZhon left a comment

Choose a reason for hiding this comment

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

LGTM

@TheDZhon TheDZhon merged commit da0d571 into lidofinance:main Dec 30, 2024
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