Skip to content

Commit

Permalink
docs: fix formatting errors (#94)
Browse files Browse the repository at this point in the history
- Fixes syntax of callouts defined in docs.
- Remove links from headers and place them in the body content.
  • Loading branch information
itsacoyote authored Jun 3, 2024
1 parent 98a1ceb commit f00f952
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 28 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -159,10 +159,11 @@ contract Example {
For more information about blocks on zkSync Era, including the differences between `block.timestamp` and `block.number`,
check out the [blocks on zkSync Documentation](/zk-stack/concepts/blocks).

::: note Changes From the Previous Protocol Version
::callout{icon="i-heroicons-light-bulb"}
**Changes From the Previous Protocol Version**<br />
Modifications were performed on how certain block properties were implemented on
zkSync Era. For details on the changes performed visit the [announcement on GitHub](https://github.com/zkSync-Community-Hub/zkync-developers/discussions/87).
:::
::

## `COINBASE`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ EIP712 transaction, accompanied by relevant data in the `paymasterInput` field.

### Paymaster Verification Rules

:::callout{icon="i-heroicons-exclamation-triangle" color="amber"}
::callout{icon="i-heroicons-exclamation-triangle" color="amber"}

- Verification rules are not fully enforced yet.
- Paymasters that do not comply with these rules may cease to function correctly in the future.

:::
::

To mitigate potential DoS attacks by malicious paymasters, a reputation scoring system similar to
[EIP4337](https://eips.ethereum.org/EIPS/eip-4337#reputation-scoring-and-throttlingbanning-for-paymasters) is used. Unlike
Expand Down
43 changes: 23 additions & 20 deletions content/00.build/95.resources/50.contribution-track.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ believe in community-driven development, and that means anyone from anywhere can
This track aims to guide you in discovering various aspects of our project, inspire you to
contribute in the ways that interest you most, and provide a pathway to connect with the zkSync community.

## Open-Source Repositories
## Open-source repositories

Here's a list of our key open-source repositories that you can contribute to:

Expand All @@ -26,11 +26,11 @@ Here's a list of our key open-source repositories that you can contribute to:

- [**era-sync_vm**](https://github.com/matter-labs/era-sync_vm): Houses the circuit implementation of zkVM specifically for zkSync Era.

### Testing and Debugging
### Testing and debugging

- [**era-test-node**](https://github.com/matter-labs/era-test-node): An in-memory node designed for integration testing and debugging.

### Development Tools
### Development tools

- [**zksync-cli**](https://github.com/matter-labs/zksync-cli): CLI tool that aims to simplify the development process on zkSync.
- [**hardhat-zksync**](https://github.com/matter-labs/hardhat-zksync): Hardhat plugins tailored for the zkSync Network.
Expand All @@ -39,14 +39,14 @@ Here's a list of our key open-source repositories that you can contribute to:

- [**zksync-web-era-docs**](https://github.com/matter-labs/zksync-web-era-docs): The go-to source for official zkSync documentation.

### SDK and Explorers
### SDK and explorers

- [**block-explorer**](https://github.com/matter-labs/block-explorer): The official block explorer for navigating the zkSync network.
- [**zksync-sdk**](https://github.com/zksync-sdk): Software Development Kit for ease of integration with the zkSync network.

Feel free to explore these repositories, and don't hesitate to contribute!

## Why the Contributors Track?
## Why the contributors track?

### Purpose

Expand All @@ -60,40 +60,43 @@ Feel free to explore these repositories, and don't hesitate to contribute!
- Open-source enthusiasts looking to contribute to a growing project.
- Those interested in contract development, dApp development, zkSync Era, and more.

## The Track
## The track

### Getting Started
### Getting started

#### 1. Introduce Yourself on [zkSync Discord](https://discord.com/invite/QKSsp7tC2x)
#### 1. Introduce yourself on zkSync Discord

- Join our Discord channel and say 'hi' in the `#introductions` thread. Share what interests you and what you're hoping to learn or contribute.
- Join our [Discord channel](https://discord.com/invite/QKSsp7tC2x) and say 'hi' in the `#introductions` thread.
Share what interests you and what you're hoping to learn or contribute.

#### 2. Follow [zkSync Developers](https://x.com/zkSyncDevs) on X (formerly Twitter)
#### 2. Follow zkSync Developers on X (formerly Twitter)

- Keep up to date with the latest news, updates, and releases by following us on X.
- Keep up to date with the latest news, updates, and releases by [following us on X](https://x.com/zkSyncDevs).

#### 3. Dive into our Official Documentation
#### 3. Dive into our official documentation

- Immerse yourself in our comprehensive official documentation to acquire essential knowledge on zkSync. If
you discover a typo, syntax error, or see room for improvement, submit a Pull Request to contribute to its enhancement.

### Dive Into Development
### Dive into development

#### 4. Deploy Your First Contract Using [zkSync-CLI](https://github.com/matter-labs/zksync-cli)
#### 4. Deploy your first contract using zkSync-CLI

- Familiarize yourself with the zkSync-CLI tool and deploy your first contract on the zkSync Era testnet.
- Familiarize yourself with the [zkSync-CLI tool](https://github.com/matter-labs/zksync-cli) and deploy your first contract on the zkSync Era testnet.

#### 5. Tackle a 'Good First Issue'

- Start contributing immediately by taking on a "Good First Issue" from any of our GitHub repositories. This is
a great way to get hands-on experience and a feel for the project.

### Community Engagement
### Community engagement

#### 6. Participate in [zkSync Developer Discussions](https://github.com/zkSync-Community-Hub/zkync-developers/discussions)
#### 6. Participate in zkSync Developer discussions

- Join the discourse on GitHub discussions or other community forums to provide answers, ask questions, or share insights.
- Join the discourse on [GitHub discussions](https://github.com/zkSync-Community-Hub/zkync-developers/discussions)
or other community forums to provide answers, ask questions, or share insights.

#### 7. Submit a [Community Tutorial](https://github.com/zkSync-Community-Hub/tutorials) or Guide
#### 7. Submit a community tutorial or guide

- Help others by sharing your knowledge. Write a tutorial or guide, then submit it to our community contributions repository or community forums.
- Help others by sharing your knowledge. Write a tutorial or guide and submit it to our
[GitHub project](https://github.com/zkSync-Community-Hub/community-code) for [Community Code](https://code.zksync.io).
8 changes: 4 additions & 4 deletions content/10.zk-stack/20.running-a-zk-chain/10.locally.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,9 +112,9 @@ An example deposit command via the bridge would look like:
npx zksync-cli bridge deposit --rpc=http://localhost:3050 --l1-rpc=http://localhost:8545
```
### Using [Portal](https://github.com/matter-labs/dapp-portal)
### Using Portal
The dApp Portal module allows you to:
The [dApp Portal](https://github.com/matter-labs/dapp-portal) module allows you to:
- View balances, transfer and bridge tokens to your ZK Chain.
- Add contacts for quick and easy access.
Expand All @@ -130,9 +130,9 @@ npm run dev:node:hyperchain
You can now navigate to the displayed Portal URL (typically <http://localhost:3000>).
### Using [Block Explorer](https://github.com/matter-labs/block-explorer)
### Using Block Explorer
A free open source block explorer is available for your ZK Chain. Block explorer contains three components
A [free open source block explorer](https://github.com/matter-labs/block-explorer) is available for your ZK Chain. Block explorer contains three components
- [Worker](https://github.com/matter-labs/block-explorer/tree/main/packages/worker)
- [API](https://github.com/matter-labs/block-explorer/tree/main/packages/api)
Expand Down

0 comments on commit f00f952

Please sign in to comment.