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

Add nethermind to docs #1

Open
wants to merge 13 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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@

# Misc
.DS_Store
.env
.env.local
.env.development.local
.env.test.local
Expand Down
23 changes: 13 additions & 10 deletions README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -124,17 +124,20 @@ To run the local build you created, run:
npm run serve
```

### Adding new words to the dictionary
### Check spelling and style

This repository includes a _linter_, which you can think of as a spell-check that also checks code
formatting and standards, and a lot more. It's possible that you might use a word in your content
that is not known to the linter, and your build, or commit, will fail.
This repository includes multiple linters, which you can think of as spell-checks that also inspect
code formatting and standards, and a lot more. It's possible that you might use an unrecognized word,
style your Markdown incorrectly, or otherwise format your content in a way that conflicts with
style guides.

You can run the linter any time with the command `npm run lint`.
The main linter, Vale, is run through Github Actions and checks spelling, formatting, and adherence to
various style guides. Please pay attention to its suggestions and error warnings in the check that
runs on your PR. These errors will not prevent your PR from building, but you should address them
nevertheless.

If the linter finds a word that it doesn't recognize, take a look at `project-words.txt` in the root
directory; if the word that the linter caught is correctly spelled, and you wish it to pass the
linter's test, add it to `project-words.txt`, save, add and commit those changes, and see if it
passes.
See our [guidance on using Vale](https://docs-template.consensys.net/contribute/run-vale) for more
information.

For tidiness, please ensure you adhere to the alphabetical order established in `project-words.txt`.
You can run other linters for code style (CSS, JavaScript) and link formatting any time with the
command `npm run lint`.
164 changes: 0 additions & 164 deletions docs/developers/community/hackathons.mdx

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ select it.
When an ERC-20 token is bridged from one chain to the other and the token has not been deployed on
the destination chain, the Token Bridge Smart Contract will attempt to determine the “decimals” of
the ERC-20 token. If the decimals cannot be determined by reading the origin ERC-20 token contract
(e.g. a token contract does not adhere to the [ERC-20 standard](https://ethereum.org/en/developers/docs/standards/tokens/erc-20/)),
(e.g. a token contract doesn't adhere to the [ERC-20 standard](https://ethereum.org/en/developers/docs/standards/tokens/erc-20/)),
it will default to 18 decimals.

This can result in the token quantities displaying incorrectly on the destination chain. For example,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ contract SuperMon is ERC721URIStorage {

```

[Deploy the smart contract using Remix](../../../quickstart/deploy-smart-contract/remix.md), or
[Deploy the smart contract using Remix](../../../quickstart/deploy-smart-contract/remix.mdx), or
[any other environment](https://docs.linea.build/developers/quickstart/deploy-smart-contract).

## Upload the images
Expand Down
2 changes: 1 addition & 1 deletion docs/developers/guides/community/irys/irys-nfts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ offchain actions.
If you're new to NFTs and smart contract development, consider deploying
one of [the audited ThirdWeb contracts](../../../../developers/quickstart/deploy-smart-contract/thirdweb.md) to learn more.

You can also [deploy this minimal contract using Remix](../../../../developers/quickstart/deploy-smart-contract/remix.md).
You can also [deploy this minimal contract using Remix](../../../../developers/quickstart/deploy-smart-contract/remix.mdx).

```solidity
// SPDX-License-Identifier: MIT
Expand Down
Loading