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.
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.
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 you do intend to submit a pull request, please open an issue first, and link to it in your pull request. This is particularly important if you are an ecosystem contributor — submitting your details in an issue first will make it much easier for our docs team to process your contributions.
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.
If you've created fleshed-out guides and tutorials, or intend to, we'd love to feature your content in our community tutorials section.
First, create an issue describing the content you want to see added or intend to add. If you're representing an organization (such as a dapp), please use the ecosystem contribution issue form.
When you're ready to start work, fork our repo, create a pull request, and tag us for review!
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!
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.
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.
- Follow the above instructions to install
nvmon your machine, or go here. - Go to root folder of this project in your terminal.
- Run
nvm installfollowed bynvm use. This will install the version specified by this project in the.nvmrcfile.
-
Navigate to root folder of the project after installing Node.js
-
Run the following in sequence, which only needs to be done once:
npm install npm run prepare
-
To preview and for every time afterwards:
npm run start
$ npm run build
This command generates static content into the build directory and can be served using any static
contents hosting service.
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.
You can run the linter any time with the command npm run lint.
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.
For tidiness, please ensure you adhere to the alphabetical order established in project-words.txt.