Skip to content

Commit da0d571

Browse files
authored
Merge pull request lidofinance#499 from voronor/patch-1
docs: Fixing typos and improving sentence clarity Update README.md
2 parents 3fa3ac3 + ea81eec commit da0d571

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Lido Docs
22

3-
Lido documentation is built using [Docusaurus 3](https://docusaurus.io/). The resulting version of documentation hosted via Github Pages from branch `gh-pages` of this repository.
3+
Lido documentation is built using [Docusaurus 3](https://docusaurus.io/). The resulting version of documentation hosted via GitHub Pages from the `gh-pages` branch of this repository..
44

55
## Installation
66

@@ -18,7 +18,7 @@ This command starts a local development server and opens up a browser window. Mo
1818

1919
## Documentation Pages
2020

21-
Documentation pages stored in `/docs` folder. By default files with `.md` and `.mdx` extensions are treated as documentation pages. Every document has a unique `id`. By default, a document `id` is the name of the document (without the extension) relative to the root docs directory.
21+
Documentation pages are stored in the `/docs` folder. By default files with `.md` and `.mdx` extensions are treated as documentation pages. Every document has a unique `id`. By default, a document `id` is the name of the document (without the extension) relative to the root docs directory.
2222

2323
For example, `greeting.md` id is `greeting` and `guide/hello.md` id is `guide/hello`.
2424

@@ -53,13 +53,13 @@ More information about document metadata fields available [there](https://docusa
5353

5454
### Documentation Sidebar
5555

56-
The appearance of sidebar controlled manually via `sidebars.js` file. This file is used to:
56+
The appearance of the sidebar is controlled manually via the `sidebars.js` file. This file is used to:
5757

5858
- Group multiple related documents
5959
- Display a sidebar on each of those documents
6060
- Provide a paginated navigation, with next/previous button
6161

62-
By default new added pages don't added to sidebar automatically. For example to add new page `faq.md` as the last item of sidebar we need modify `sidebar.js` next way:
62+
By default, newly added pages are not added to the sidebar automatically. 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:
6363

6464
```js
6565
module.exports = {
@@ -83,9 +83,9 @@ This command generates static content into the `build` directory and can be serv
8383

8484
## Deployment
8585

86-
Build and deploy happens automatically when pull request is merged to `main`branch or someone pushes to `main` branch directly.
86+
Build and deployment happen automatically when a pull request is merged to the `main` branch or someone pushes to the `main` branch directly.
8787

88-
To build documentation locally and push built version to the `gh-pages` branch use next command:
88+
To build the documentation locally and push the built version to the `gh-pages` branch, use the following command:
8989

9090
```console
9191
GIT_USER=<Your GitHub username> USE_SSH=true npm run deploy

0 commit comments

Comments
 (0)