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

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).

Alternatively, get in touch via the community forum or the Linea Discord if you have an issue or question.

Please follow these steps if you wish to contribute:

1. Please make an issue describing the change you wish to make before you start working on it, 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.
2. Fork our repo so that you're able to work on it.
3. Make your changes, paying attention to our contribution guidelines.
4. Review your changes locally. See our guide on previewing your changes locally.
5. Submit your changes as a pull request. New pull requests are reviewed regularly.

Contribution guidelines

The style of the documentation is based on the Consensys style guide.

Please return to any submitted PRs regularly to help us work through feedback and comments and merge them as soon as we can. If you do not return to your PR for edits within three months of us reviewing, we will close the PR.

Guidance for ecosystem contributions

By "ecosystem contributions", we mean contributions from projects in the Linea ecosystem, such as dapps, libraries, or tooling. If your submission is in this category, please keep the following guidelines in mind:

• Your contribution should be informative above all; the docs are not a marketing tool for your project. We may request edits to adjust your writing style if we feel it falls on the wrong side of this line. We encourage you to write about your project's features and benefits, but please avoid superlatives or selling your project.
• You are responsible for maintaining the information about your project. Out-of-date docs will be an inconvenience for users at best, or leave a negative impression of your project at worst. This includes keeping links to external sites up-to-date and returning for updates as your project matures.

Contribute to community tutorials

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.

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.

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 the 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

3. To preview and for every time afterwards:

   npm run start

Build

npm run build

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

To run the local build you created, run:

npm run serve

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 might 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.