Skip to content

Commit 8d55e6c

Browse files
authored
Merge pull request #1812 from ethereum-optimism/sb-nextra-cleanup
cleaning up leftover nextra stuff
2 parents 9b39fbe + 372e30b commit 8d55e6c

20 files changed

+25
-938
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,30 @@
33
Thanks for taking the time to contribute! ❤️
44

55
## Table of Contents
6-
- [Overview](#overview)
7-
- [Getting Started](#getting-started)
8-
- [Prerequisites](#prerequisites)
9-
- [Development Setup](#development-setup)
10-
- [Contributing Process](#contributing-process)
11-
- [File Architecture](#file-architecture)
12-
- [Content Guidelines](#content-guidelines)
13-
- [Local Testing](#local-testing)
14-
- [Pull Request Process](#pull-request-process)
15-
- [Before Submitting](#before-submitting)
16-
- [Submission Guidelines](#submission-guidelines)
17-
- [Review Process](#review-process)
18-
- [Code of Conduct](#code-of-conduct)
19-
- [Additional Ways to Contribute](#additional-ways-to-contribute)
6+
- [Contributing to Optimism Docs](#contributing-to-optimism-docs)
7+
- [Table of Contents](#table-of-contents)
8+
- [Overview](#overview)
9+
- [Getting Started](#getting-started)
10+
- [Prerequisites](#prerequisites)
11+
- [Development Setup](#development-setup)
12+
- [Contributing Process](#contributing-process)
13+
- [File Architecture](#file-architecture)
14+
- [Content Guidelines](#content-guidelines)
15+
- [Local Testing](#local-testing)
16+
- [Pull Request Process](#pull-request-process)
17+
- [Before Submitting](#before-submitting)
18+
- [Submission Guidelines](#submission-guidelines)
19+
- [Review Process](#review-process)
20+
- [Code of Conduct](#code-of-conduct)
21+
- [Additional Ways to Contribute](#additional-ways-to-contribute)
2022

2123
## Overview
2224

2325
Optimism's documentation is open-source and hosted on GitHub in the `ethereum-optimism/docs` repository. The documentation is rendered at [docs.optimism.io](https://docs.optimism.io). You can contribute either by:
2426
- Forking the `docs` repository and working locally
25-
- Using the "Edit this page" button on any documentation page for smaller updates
27+
- Using the "Suggest edits" button on any documentation page for smaller updates
2628

27-
All contributions, pull requests, and issues should be in English at this time. We will be running a dedicated project in the future to add language support to the technical docs, so please reach out via our [developer support channel](https://github.com/ethereum-optimism/developers/) if you are interested in helping with that project.
29+
All contributions, pull requests, and issues should be in English at this time.
2830

2931
## Getting Started
3032

@@ -45,56 +47,33 @@ You can now start changing content and see the website updated live each time yo
4547
## Contributing Process
4648

4749
### File Architecture
48-
Our documentation is organized into two main sections:
4950

50-
| Section | Purpose | Location |
51-
|---------|----------|----------|
52-
| Pages | Technical documentation content | `/docs/pages/` |
53-
| Public | Images, icons, and illustrations | `/docs/public/` |
51+
See the [mintlify docs](https://www.mintlify.com/docs/organize/navigation).
5452

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

5755
### Content Guidelines
58-
We use [Nextra](https://nextra.site/docs), a React and MDX-based framework with the docs theme (as opposed to the blog theme). The content you write is [Markdown](https://daringfireball.net/projects/markdown/syntax) that accepts [React](https://reactjs.org/) components.
56+
We use [mintlify](https://www.mintlify.com/docs) to power our docs.
5957

60-
Please refer to our comprehensive [Style Guide](/pages/connect/contribute/style-guide.mdx) for detailed formatting instructions.
58+
Please refer to our comprehensive [Style Guide](/reference/contribute/style-guide) for detailed formatting instructions.
6159

6260
### Local Testing
63-
Before submitting your changes:
64-
1. Stop or delete the terminal server if it's running
65-
2. Run `pnpm dev` to test builds
66-
3. Execute `pnpm fix` for automatic linting
67-
4. Run `pnpm spellcheck:lint` for spell checking
68-
- Add new words to the dictionary by appending them to `words.txt`
69-
5. Use `pnpm spellcheck:fix` to update dictionary
70-
6. Try another `pnpm dev` and repeat until no issues are reported ("client" and "server compiled successfully")
71-
72-
If you encounter build issues:
73-
- Check terminal output for error messages
74-
- Verify all links are working
75-
- Ensure proper formatting according to the style guide
76-
- Test locally before pushing changes
61+
62+
Follow these [docs](https://www.mintlify.com/docs/installation) for local changes.
7763

7864
## Pull Request Process
7965

8066
### Before Submitting
81-
- Ensure all local tests pass
8267
- Fix any reported issues
8368
- Verify content accuracy
8469
- Test all links and references
85-
- Target the `main` branch (unless otherwise specified)
70+
- Target the `mintlify` branch (`main` needs to be cleaned up)
8671

8772
### Submission Guidelines
8873
1. Create a [new pull request](https://github.com/ethereum-optimism/docs/issues/new/choose)
8974
2. Choose appropriate PR type or use blank template
9075
3. Provide clear title and accurate description
91-
4. Add required labels:
92-
- `documentation` (required for all PRs)
93-
- Content-specific: `tutorial`, `faq`, `troubleshooting`
94-
- Feature-specific: `oracle`, `rpc-provider`, `faucet`, `attestation`
95-
- Issue-specific: `user feedback`, `bug`
96-
97-
> **Note**: If label type is not set, the Documentation team will set or update it for you.
76+
4. Add labels
9877

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

pages/404.mdx

Lines changed: 0 additions & 3 deletions
This file was deleted.

pages/500.mdx

Lines changed: 0 additions & 3 deletions
This file was deleted.

pages/app-developers/bridging.mdx

Lines changed: 0 additions & 22 deletions
This file was deleted.

pages/app-developers/bridging/basics.mdx

Lines changed: 0 additions & 18 deletions
This file was deleted.

pages/app-developers/bridging/custom-bridge.mdx

Lines changed: 0 additions & 25 deletions
This file was deleted.

pages/app-developers/bridging/messaging.mdx

Lines changed: 0 additions & 159 deletions
This file was deleted.

0 commit comments

Comments
 (0)