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
+6-6
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
Welcome to the Mina Docs open source repository. Thank you for your interest in contributing to the [Mina Docs](https://docs.minaprotocol.com/) website.
4
4
5
-
We realize that technical documentation is a high-visibility interface with you: our community and our users. We work hard to deliver well-written docs to help you discover, understand, and use the Mina Protocol and SnarkyJS.
5
+
We realize that technical documentation is a high-visibility interface with you: our community and our users. We work hard to deliver well-written docs to help you discover, understand, and use the Mina Protocol and o1js.
6
6
7
7
We treat documentation like code. The Mina Docs use a docs-as-code workflow to develop and publish product documentation using the same tools and processes as software code development. All user-impacting updates on the codebase require corresponding updates to the relevant documentation in the docs repo. Developers who know the feature best write the first draft of content for all changes and new features. Feature documentation is part of our development “definition of done.”
8
8
@@ -38,7 +38,7 @@ If you don't find what you are looking for or something in the docs is not worki
38
38
39
39
## Reviewing Technical Content PRs
40
40
41
-
Some of the best content contributions come during the PR review cycles. To ensure quality, follow best practices for technical content PR reviews just like you do for code reviews. When reviewing a pull request, the end-goal is to suggest useful changes to the author.
41
+
Some of the best content contributions come during the pull request (PR) review cycles. To ensure quality, follow best practices for technical content PR reviews just like you do for code reviews. When reviewing a pull request, the end-goal is to suggest useful changes to the author.
42
42
43
43
- For in-line suggestions, use the [GitHub suggesting feature](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).
44
44
- You can comment on one line or several lines. You can provide changes or edits, and the person who authored the PR can easily apply your change, or create their own competing suggestion, and you can discuss it. To invite others to the conversation, tag their GitHub @username in a comment to notify them. In this way, you can discuss any change. It’s transparent and inclusive.
@@ -49,9 +49,9 @@ Some of the best content contributions come during the PR review cycles. To ensu
49
49
50
50
You are welcome to provide a fix or update directly. We appreciate your contributions!
51
51
52
-
- For a simple fix to single page, you can select **EDIT THIS PAGE** at the top of the page to make changes to the file in a web browser. In the **Propose changes** section, you can follow the GitHub workflow to submit a pull request.
52
+
- For a simple fix to single page, you can select **EDIT THIS PAGE** at the top of the page to make changes to the file in a web browser. In the **Propose changes** section, you can follow the GitHub workflow to submit a PR.
53
53
54
-
- If you're not a member or maintainer, fork the repo and then submit a pull request (PR) from your forked repo to the `main` branch.
54
+
- If you're not a member or maintainer, fork the repo and then submit a PR from your forked repo to the `main` branch.
55
55
56
56
Provide a helpful, informative PR title that includes the context and page you are updating. Each PR must address only one issue or feature.
57
57
@@ -62,8 +62,8 @@ All pull requests must go through the code review process. As the PR submitter,
62
62
- If you are a member of the docs repo, you can merge the approved PR.
63
63
- If your PR is a fork, the code maintainers will merge the approved PR.
64
64
65
-
### SnarkyJS Reference
65
+
### o1js Reference
66
66
67
-
The zkApp Developers > [SnarkyJS Reference](https://docs.minaprotocol.com/zkapps/snarkyjs-reference) docs are generated content and are outside the scope of the Mina Docs repository.
67
+
The zkApp Developers > [o1js Reference](https://docs.minaprotocol.com/zkapps/o1js-reference) docs are generated content and are outside the scope of the Mina Docs repository.
68
68
69
69
Thank you for contributing to the Mina docs. It's better together.
Copy file name to clipboardExpand all lines: README.md
+5-3
Original file line number
Diff line number
Diff line change
@@ -6,14 +6,16 @@ The Mina Docs website is [docs.minaprotocol.com](https://docs.minaprotocol.com/)
6
6
7
7
## To contribute content
8
8
9
-
Thank you for your interest. See the docs [CONTRIBUTING](CONTRIBUTING.md) guidelines.
10
-
11
-
## How to see your doc updates during development
9
+
Thank you for your interest in contributing to the docs. To get started, see the docs [CONTRIBUTING](CONTRIBUTING.md) guidelines.
12
10
13
11
The docs output is generated by a CI pipeline so we can update the docs site whenever we want. The [Mina Docs](https://docs.minaprotocol.com/) website always contains the most up-to-date content available.
14
12
13
+
## How to see your doc updates on PRs
14
+
15
15
During the documentation build process, each PR goes through Vercel CI to test the doc updates and build a preview of your changes. Vercel for GitHub automatically deploys and provides preview deployment URLs. After the PR status is ready, click **Visit Preview** and navigate to the changed page to see your doc updates.
16
16
17
+
## How to see your doc updates during development
18
+
17
19
To test the doc build and see local updates before you push changes to GitHub, be sure to build the docs locally.
18
20
<!-- In case of version change, update .github/workflows/{test-tutorials.yml, snarkjs-api-reference.md} accordingly -->
0 commit comments