You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+25-46Lines changed: 25 additions & 46 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,28 +3,30 @@
3
3
Thanks for taking the time to contribute! ❤️
4
4
5
5
## 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)
20
22
21
23
## Overview
22
24
23
25
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:
24
26
- 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
26
28
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.
28
30
29
31
## Getting Started
30
32
@@ -45,56 +47,33 @@ You can now start changing content and see the website updated live each time yo
45
47
## Contributing Process
46
48
47
49
### File Architecture
48
-
Our documentation is organized into two main sections:
| Public | Images, icons, and illustrations |`/docs/public/`|
51
+
See the [mintlify docs](https://www.mintlify.com/docs/organize/navigation).
54
52
55
53
**Warning**: The `public` folder contains `robots.txt` and `sitemap.xml` for SEO purposes. These files are maintained by the Documentation team only.
56
54
57
55
### 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.
59
57
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.
61
59
62
60
### 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.
77
63
78
64
## Pull Request Process
79
65
80
66
### Before Submitting
81
-
- Ensure all local tests pass
82
67
- Fix any reported issues
83
68
- Verify content accuracy
84
69
- Test all links and references
85
-
- Target the `main` branch (unless otherwise specified)
70
+
- Target the `mintlify` branch (`main` needs to be cleaned up)
86
71
87
72
### Submission Guidelines
88
73
1. Create a [new pull request](https://github.com/ethereum-optimism/docs/issues/new/choose)
89
74
2. Choose appropriate PR type or use blank template
0 commit comments