billy19191/docs

Optimism Developer Docs

Optimism Docs

This repo houses the Optimism Docs located at docs.optimism.io. All documentation related updates and new content will be tracked and maintained in this repo.

Local Development

How to install pnpm

First, run pnpm i to install the dependencies.

Then, run pnpm dev to start the development server and visit localhost:3000.

Contributions

Please see the CONTRIBUTING.md page for specifics on how to write PRs, use the linter, run spellcheck, add dictionary terms, etc. You should also review the Optimism Documentation Style Guide for additional guidelines, especially if you are writing entirely brand new pages to the developer docs, as opposed to smaller edits and/or revisions.

Project Board

Documentation updates are tracked on the following project board. You can also track issues or submit documentation requests directly from this repo.

License

This project is licensed under the MIT License.