Skip to content

Latest commit

 

History

History
104 lines (78 loc) · 3.88 KB

CONTRIBUTING.md

File metadata and controls

104 lines (78 loc) · 3.88 KB

Contributing to Optimism Docs

Thanks for taking the time to contribute! ❤️

Table of Contents

Overview

Optimism's documentation is open-source and hosted on GitHub in the ethereum-optimism/docs repository. The documentation is rendered at docs.optimism.io. You can contribute either by:

  • Forking the docs repository and working locally
  • Using the "Suggest edits" button on any documentation page for smaller updates

All contributions, pull requests, and issues should be in English at this time.

Getting Started

Prerequisites

  • Basic knowledge of Git and GitHub
  • Familiarity with Markdown
  • Understanding of technical documentation principles
  • Node.js and npm installed

Development Setup

  1. Install pnpm
  2. Run pnpm i to install dependencies
  3. Run pnpm dev to start development server
  4. Visit localhost:3000

You can now start changing content and see the website updated live each time you save a new file. 🤓

Contributing Process

File Architecture

See the mintlify docs.

Warning: The public folder contains robots.txt and sitemap.xml for SEO purposes. These files are maintained by the Documentation team only.

Content Guidelines

We use mintlify to power our docs.

Please refer to our comprehensive Style Guide for detailed formatting instructions.

Local Testing

Follow these docs for local changes.

Pull Request Process

Before Submitting

  • Fix any reported issues
  • Verify content accuracy
  • Test all links and references
  • Target the mintlify branch (main needs to be cleaned up)

Submission Guidelines

  1. Create a new pull request
  2. Choose appropriate PR type or use blank template
  3. Provide clear title and accurate description
  4. Add labels

Important: Add flag:merge-pending-release label if the PR content should only be released publicly in sync with a product release.

Tip: Use "Create draft pull request" if your work is still in progress.

Review Process

  1. Assignment to Documentation team member
  2. Technical review for accuracy
  3. Quality and scope alignment check
  4. Minimum 1 reviewer approval required
  5. Reviewers will either approve, request changes, or close the pull request with comments
  6. Automatic deployment after merge to docs.optimism.io

Code of Conduct

  • Be respectful and inclusive
  • Follow project guidelines
  • Provide constructive feedback
  • Maintain professional communication
  • Report inappropriate behavior

Additional Ways to Contribute

Even without direct code contributions, you can support us by:

  • ⭐ Starring the project
  • 🐦 Sharing on social media
  • 📝 Mentioning us in your projects
  • 🗣️ Spreading the word in your community

Thank you for contributing to Optimism Docs! 🎉