Skip to content

feat: Enhance README with badges, social links, and improved formatting #1451

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 29 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,44 @@
# Optimism Docs
![Optimism Logo](https://github.com/ethereum-optimism/docs/blob/main/public/logos/docs-header.png)

[![GitHub issues](https://img.shields.io/github/issues/ethereum-optimism/docs)](https://github.com/ethereum-optimism/docs/issues)
[![GitHub forks](https://img.shields.io/github/forks/ethereum-optimism/docs)](https://github.com/ethereum-optimism/docs/network)
[![GitHub stars](https://img.shields.io/github/stars/ethereum-optimism/docs)](https://github.com/ethereum-optimism/docs/stargazers)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/ethereum-optimism/optimism/blob/develop/LICENSE)

This repo houses the Optimism Docs located at [docs.optimism.io](https://docs.optimism.io/). All documentation-related updates and new content will be tracked and maintained in this repo.

## Local Development
## 🚀 Local Development

How to [install pnpm](https://pnpm.io/installation)
💡 How to [install pnpm](https://pnpm.io/installation)

First, run `pnpm i` to install the dependencies.
```sh
pnpm i # Install dependencies
```

Then, run `pnpm dev` to start the development server and visit localhost:3000.
```sh
pnpm dev # Start the development server
```
Visit `localhost:3000` to view the documentation locally.

## Contributions
## 🛠 Contributions

Please see the [CONTRIBUTING.md](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](/pages/connect/contribute/style-guide.mdx) for additional guidelines, especially if you are writing entirely brand new pages to the developer docs, as opposed to smaller edits and/or revisions.
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
## 📌 Project Board

You can track documentation [issues](https://github.com/ethereum-optimism/docs/issues) or submit documentation [requests](https://github.com/ethereum-optimism/docs/issues/new/choose) directly from this repo.

## License
## 📜 License

This project is licensed under the [MIT License](https://github.com/ethereum-optimism/optimism/blob/develop/LICENSE).

## 🌐 Connect with Us

[![X (Twitter)](https://img.shields.io/badge/Follow%20on%20X-000000?logo=x&logoColor=white&style=for-the-badge)](https://x.com/optimism)
[![Discord](https://img.shields.io/badge/Discord-%237289DA.svg?style=for-the-badge&logo=discord&logoColor=white)](https://discord.com/invite/optimism)
[![GitHub](https://img.shields.io/badge/GitHub-%23181717.svg?style=for-the-badge&logo=github&logoColor=white)](https://github.com/ethereum-optimism)
[![Website](https://img.shields.io/badge/Website-%23FF0420.svg?style=for-the-badge&logo=google-chrome&logoColor=white)](https://www.optimism.io/)

💡 Stay connected, contribute, and help us build a better ecosystem!