ggramo / doc.zk-evm

Linea documentation

Linea documentation

Linea is a developer-ready Layer 2 network, scaling Ethereum by providing an Ethereum-equivalent environment in which to execute transactions, which are then submitted to Ethereum Mainnet through a zero-knowledge rollup.

This documentation repository is built using Docusaurus, and the site itself is published at docs.linea.build.

See more information about how Consensys uses Docusaurus.

Contribute to the docs

See something missing? Error in our documentation? Create an issue here.

Alternatively, help us improve our documentation! Fork our repo, create a pull request, and tag us for review! (for help on this, see below)

Take a look at some good first issues to get started.

How to submit a suggestion or change

The best way to suggest a change to these docs is through a process known as a pull request. If you're not familiar with how that works, check out GitHub's guide here.

If that process is too involved for you, you can always open a thread on the Community forum, or a ticket on the Support page.

If you are familiar with making a pull request, we highly recommend that you run a version of these docs locally, and preview your changes locally, before submitting them. In fact, it's part of the PR process.

Running locally

You will need to have Node.js installed to run the live previews of the docs locally.

It is highly recommended that you use a tool like nvm to manage Node.js versions on your machine.

Installing recommended Node.js version with nvm

1. Follow the above instructions to install nvm on your machine, or go here.
2. Go to root folder of this project in your terminal.
3. Run nvm install followed by nvm use. This will install the version specified by this project in the .nvmrc file.

Running this project

1. Navigate to root folder of the project after installing Node.js

2. Run the following in sequence, which only needs to be done once:

   npm install
   npm run prepare

3. To preview and for every time afterwards:

   npm run start

Local Development

$ npm install
$ npm run prepare
$ npm start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Adding new words to the dictionary

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 will use a word in your content that is not known to the linter, and your build, or commit, will fail.

If this happens, take a look at project-words.txt in the root directory of your project; 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.

Local development

$ npm install
$ npm run prepare
$ npm start
$ git commit

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ npm run build
$ npm run serve

This command generates static content into the build directory.

Contribute to community tutorials

If you've created more fleshed out guides and tutorials, we'd love to feature your content in our community tutorials section. Fork our repo, create a pull request, and tag us for review!

You can learn how to add a post under the /blog directory by following the Docusaurus instructions for adding posts.

Contribute to the Zero-Knowledge Glossary

Diving into zero-knowledge rollups and getting stumped by the technical jargon? We've started an open source Zero-Knowledge glossary to define some common terms you might encounter as you dive into the L2 landscape.

Fork our repo, and add a term in alphabetical order to docs/reference/glossary.md. Then, make a pull request and tag us for review!

Additional Resources

View the Consensys doc contribution guidelines for information on how to:

• Submit a contribution using forks and pull requests.
• Consult the documentation style guide.
• Format your Markdown correctly.
• Preview the docs locally.