diff --git a/README.mdx b/README.mdx index 873788c367..958423fdfe 100644 --- a/README.mdx +++ b/README.mdx @@ -5,12 +5,12 @@ # Linea documentation -## Quick Links 🔗 -- [Documentation Website](https://docs.linea.build/) -- [Community Forum](https://community.linea.build/) +## Quick links +- [Documentation website](https://docs.linea.build/) +- [Community forum](https://community.linea.build/) - [Discord](https://discord.gg/linea) -- [Create an Issue](https://github.com/Consensys/doc.linea/issues) -- [Fork Repository](https://github.com/ConsenSys/doc.linea/fork) +- [Create an issue](https://github.com/Consensys/doc.linea/issues) +- [Fork repository](https://github.com/ConsenSys/doc.linea/fork) ## What is Linea? @@ -21,28 +21,6 @@ Ethereum Mainnet through a zero-knowledge rollup. This documentation repository is built using [Docusaurus](https://docusaurus.io/), and the site itself is published at [`docs.linea.build`](https://docs.linea.build/). -## How to Contribute 🤝 - -### Before You Start -1. **Create an Issue First** - Before making any changes, create an issue describing what you want to change -2. **Fork the Repository** - [Fork our repo](https://github.com/ConsenSys/doc.linea/fork) -3. **Set Up Locally** - Follow our [local setup guide](#running-locally) - -### Making Changes -1. Create a new branch for your changes -2. Make your updates following our [contribution guidelines](#contribution-guidelines) -3. Test your changes locally using `npm run start` -4. Run linters using `npm run lint` -5. Commit your changes with clear commit messages - -### Submitting Changes -1. Push your changes to your fork -2. Create a Pull Request (PR) and link it to your issue -3. Wait for review from our team -4. Address any feedback promptly - -See [more](https://docs-template.consensys.net/) information about how Consensys uses Docusaurus. - ## Contribute See something missing? Error in our documentation? Create an issue [here](https://github.com/Consensys/doc.linea/issues).