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

Docs fix spelling issues #1088

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,10 @@ A set of services used by [Blockscout](https://blockscout.com/) blockchain explo

## Running and configuring services

Services are distributed as docker images. For each service you can find information about packages and their recent releases
Services are distributed as docker images. For each service, you can find information about packages and their recent releases
inside service directories.

You can configure your app by passing necessary environment variables when starting the container.
You can configure your app by passing the necessary environment variables when starting the container.
Configuration variables common for all services can be found [here](docs/common-envs.md).
See full list of ENVs and their description inside service directories.

Expand Down Expand Up @@ -73,13 +73,13 @@ The separation on "logic" and "server" crates is designed to separate functional
For now, "server" crates contain gRPC and HTTP as the transport layer.
It was assumed, that users may want to implement their own APIs, for which the library with functional logic might be used.

Crates that require database connection may also have additional sea-orm defined crates:
Crates that require database connection may also have additional sea-orm-defined crates:
Copy link
Collaborator

Choose a reason for hiding this comment

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

why? sea-orm is name of library

Copy link
Author

Choose a reason for hiding this comment

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

The hyphenation removes ambiguity and ensures the phrase is interpreted correctly as "crates that are defined by sea-orm."

1. `{service-name}-migration` - contains migrations for the database
2. `{service-name}-entity` - contains the entity files generated from the schema

## Contributing

We appreciate your support. Before writing code and submitting pull request, please read contributing [instructions](CONTRIBUTING.md).
We appreciate your support. Before writing code and submitting a pull request, please read contributing [instructions](CONTRIBUTING.md).


## License
Expand Down
2 changes: 1 addition & 1 deletion blockscout-ens/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This project provides indexed data of domain name service for blockscout instances.

Here is brief overview of the project stucture:
Here is brief overview of the project structure:

![bens-structure](images/bens.drawio.svg)

Expand Down
2 changes: 1 addition & 1 deletion da-indexer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ just migrate-up
```bash
just generate-entities
```
+ Now you ready to start API server! Just run it:
+ Now you are ready to start API server! Just run it:
```
just run
```
Expand Down
2 changes: 1 addition & 1 deletion eth-bytecode-db/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The Ethereum Bytecode Database is a cross-chain smart contract database
designed for automatic contract verification. It serves as a proxy between users
and the [smart-contract-verifier](../smart-contract-verifier) service.
This servcice stores verified contract data in the database
This service stores verified contract data in the database
and enables searches for contracts with similar bytecodes.

You will recognize the service in action when you see the notification:
Expand Down