Skip to content

Commit 8e5dcd6

Browse files
authored
Clarify preview feedback path on contribution docs (#418)
* Clarify Vercel preview feedback path * Correct preview feedback workflow in contribution docs * Clarify preview feedback workflow * Clarify Vercel preview feedback path * Correct preview feedback workflow in contribution docs * Clarify preview feedback workflow * Fix contribution docs consistency * docs: update contributor Discord channel references
1 parent 051babb commit 8e5dcd6

File tree

3 files changed

+54
-40
lines changed

3 files changed

+54
-40
lines changed

AGENTS.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Clone Notes
2+
3+
- This is an isolated checkout for PR `#418` on `security-alliance/frameworks`.
4+
- Edit `docs/pages/contribute/contributing.mdx` and regenerate the root `CONTRIBUTING.md` with `node utils/sync-contributing.js`.
5+
- Keep Discord channel references aligned with the reviewer-approved `frameworks-contribs` wording.

CONTRIBUTING.md

Lines changed: 38 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -4,36 +4,36 @@ This file is automatically synced from docs/pages/contribute/contributing.mdx du
44
⚠️ DO NOT EDIT THIS FILE DIRECTLY.
55
Instead, make changes to docs/pages/contribute/contributing.mdx and make this be synced just by running the build command.
66
7-
Both files contain the same content: the docs file is there to render the content on the website, while this copy is
8-
needed to make it highlighted in the repository dashboard.
7+
Both files contain the same content: the docs file is there to render the content on the website,
8+
while this copy is needed to make it highlighted in the repository dashboard.
99
-->
1010

1111
# **Contributing guidelines**
1212

1313
The Security Frameworks is an open and collaborative initiative. Whether you are part of the Security Alliance or not,
1414
we welcome your contributions! Help us build the documentation and improve security in the blockchain ecosystem.
1515

16-
This handbook is designed for easy collaboration and automatic deployment through continuous integration.
17-
If you'd like to join our effort, feel free to fix typos, contribute new sections, or propose enhancements.
16+
This handbook is designed for easy collaboration and automatic deployment through continuous integration. If you'd like
17+
to join our effort, feel free to fix typos, contribute new sections, or propose enhancements.
1818

19-
**Before contributing, please read our
20-
[Code of Conduct](https://github.com/security-alliance/frameworks/blob/develop/CODE_OF_CONDUCT.md)**
21-
to ensure that all interactions remain respectful, inclusive, and constructive.
19+
**Before contributing, please read our [Code of
20+
Conduct](https://github.com/security-alliance/frameworks/blob/develop/CODE_OF_CONDUCT.md)** to ensure that all
21+
interactions remain respectful, inclusive, and constructive.
2222

2323
**Before contributing to SEAL Certifications** specifically, please read the [SEAL Certifications
2424
Contributing Guide](/certs/contributions.mdx) for details on the certification framework and project specifics.
2525

2626
Join our [Discord](https://discord.gg/securityalliance) server, let others know what you are working on in the
27-
frameworks-reviewers’ group channel, and collaborate with other contributors writing about related topics.
27+
`frameworks-contribs` group channel, and collaborate with other contributors writing about related topics.
2828

2929
## Live versions
3030

3131
The source code for the Security Frameworks is hosted on GitHub:
3232
[github.com/security-alliance/frameworks](https://github.com/security-alliance/frameworks).
3333

3434
- The **main branch** powers the stable Frameworks website
35-
([https://frameworks.securityalliance.org/](https://frameworks.securityalliance.org/)) with reviewed and finalized
36-
content.
35+
([https://frameworks.securityalliance.org/](https://frameworks.securityalliance.org/)) with reviewed and
36+
finalized content.
3737
- The **development branch** ([https://frameworks.securityalliance.dev/](https://frameworks.securityalliance.dev/))
3838
contains ongoing updates, new sections, and draft content.
3939

@@ -50,26 +50,31 @@ First, check existing PRs or branches to make sure your work has not been previo
5050
- Use the **“Contribute today!”** button at the bottom of any page
5151
- Make fixes, formatting, and clarifications, favoring major modifications over just a few grammar mistakes
5252
- Changes go through GitHub’s web interface without requiring local setup
53+
- If someone already has an open PR, you can review the Cloudflare Pages preview linked from that PR and leave
54+
proofreading or feedback on the PR itself without opening your own PR. This is a rendered preview for review, not a
55+
separate commenting feature on the live site.
5356

5457
### 2. Add a new section or expand an existing one
5558

5659
All contributions should follow this workflow:
5760

5861
1. **Fork the repository** to your own GitHub account.
59-
2. **Follow the [`template.mdx`](/docs/pages/config/template.mdx) page** when creating or expanding content.
60-
It contains pre-defined components and structure required for consistency in MDX files.
62+
2. **Follow the [`template.mdx`](https://github.com/security-alliance/frameworks/blob/develop/docs/pages/config/template.mdx)
63+
page** when creating or expanding content. It contains pre-defined components and structure required for consistency
64+
in MDX files.
6165
3. **Make your changes** in MDX (typos, improvements, or new content) on your fork.
62-
4. **Open a Pull Request (PR) against the `develop` branch** of this repository. Once submitted, you can see the
63-
deployment through the automated preview and make any final adjustments.
66+
4. **Open a Pull Request (PR) against the `develop` branch** of this repository. Once submitted, use the Cloudflare
67+
Pages preview linked from the PR to verify the rendered site and make any final adjustments before review. All
68+
feedback and discussion should stay on the PR itself.
6469
5. **Notify reviewers** by tagging a steward or maintainer, requesting reviews directly in your PR.
65-
6. Additionally, you can paste your PR and/or potential associated issues to the `framework-contribs` Discord channel.
70+
6. Additionally, you can paste your PR and/or potential associated issues to the `frameworks-contribs` Discord channel.
6671
7. Once reviewed and approved, your changes will be merged into `develop`.
6772
8. Don't forget to add yourself to the YAML header of the file you're modifying, since that is how we provide
68-
attribution. You should also create your profile inside the contributors list, at `docs/config/contributors.json`.
73+
attribution. You should also create your profile inside the contributors list, at `docs/pages/config/contributors.json`.
6974
9. Periodically, reviewed content from `develop` is merged into `main` for the stable site.
7075

71-
If you’re interested in a framework that doesn’t currently have an active steward, you can **become one yourself**.
72-
See the [Stewards guide](/docs/pages/contribute/stewards.mdx) for details on responsibilities and how to get started.
76+
If you’re interested in a framework that doesn’t currently have an active steward, you can **become one yourself**. See
77+
the [Stewards guide](/docs/pages/contribute/stewards.mdx) for details on responsibilities and how to get started.
7378

7479
**⚠️ Please sign and verify all commits.** (If you have unsigned commits, follow the “Fixing Unsigned Commits” section
7580
below to update them)
@@ -82,8 +87,8 @@ Choose the development approach that works best for you:
8287

8388
The easiest way to get started is using our pre-configured devcontainer with VSCode:
8489

85-
1. **Prerequisites**: VSCode with
86-
[Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
90+
1. **Prerequisites**: VSCode with [Dev Containers
91+
extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
8792
2. **Open the project**: VSCode will detect the devcontainer configuration
8893
3. **Reopen in container**: Command Palette (Ctrl+Shift+P) → "Dev Containers: Reopen in Container"
8994
4. **Start developing**: All tools are pre-installed and ready to use
@@ -142,14 +147,14 @@ If you prefer to install dependencies locally on your machine:
142147

143148
5. Once the server is running, access the site at port ```5173```
144149

145-
**(Optional) Authenticate with GitHub CLI**: The GitHub CLI (`gh`) is already preinstalled in the devcontainer.
146-
You can authenticate by running `gh auth login` in the terminal, making it easy to interact with GitHub directly
147-
from your development environment.
150+
**(Optional) Authenticate with GitHub CLI**: The GitHub CLI (`gh`) is already preinstalled in the devcontainer. You can
151+
authenticate by running `gh auth login` in the terminal, making it easy to interact with GitHub directly from your
152+
development environment.
148153

149154
## Fixing unsigned commits
150155

151-
If you accidentally made unsigned commits in your fork, you’ll need to rewrite them so they show as **Verified**
152-
before opening a PR.
156+
If you accidentally made unsigned commits in your fork, you’ll need to rewrite them so they show as **Verified** before
157+
opening a PR.
153158

154159
### 1. Rebase your recent commits
155160

@@ -266,7 +271,7 @@ Contributors are **managed centrally**:
266271
267272
This helps track contributions and ensures proper attribution.
268273
269-
For a complete frontmatter example, see the [template file](/docs/pages/config/template.mdx).
274+
For a complete frontmatter example, see the [template file](https://github.com/security-alliance/frameworks/blob/develop/docs/pages/config/template.mdx?plain=1).
270275
271276
### 2. Sidebar / Navigation
272277
@@ -328,13 +333,13 @@ comparisons, or anecdotes to clarify complex topics.
328333
### Content standardization
329334
330335
- Use **American English** consistently.
331-
- Follow consistent terminology, capitalization, and nomenclature (see
332-
[Ethereum.org style guide](https://ethereum.org/contributing/style-guide/content-standardization)).
333-
- Usage of images and visualizations is encouraged. If you are using an image created by a third party,
334-
make sure its license allows it and provide a link to the original. For creating your own visualizations,
335-
we suggest [excalidraw.com](https://github.com/excalidraw/excalidraw).
336-
- Feel free to use [emojis](https://docsify.js.org/#/emoji?id=emoji) or [icons](https://icongr.am/fontawesome)
337-
where it fits, for example in block-quotes.
336+
- Follow consistent terminology, capitalization, and nomenclature (see [Ethereum.org style
337+
guide](https://ethereum.org/contributing/style-guide/content-standardization)).
338+
- Usage of images and visualizations is encouraged. If you are using an image created by a third party, make sure its
339+
license allows it and provide a link to the original. For creating your own visualizations, we suggest
340+
[excalidraw.com](https://github.com/excalidraw/excalidraw).
341+
- Feel free to use [emojis](https://docsify.js.org/#/emoji?id=emoji) or [icons](https://icongr.am/fontawesome) where it
342+
fits, for example in block-quotes.
338343
339344
### Visual representation / drawings
340345

docs/pages/contribute/contributing.mdx

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ interactions remain respectful, inclusive, and constructive.
3636
Contributing Guide](/certs/contributions.mdx) for details on the certification framework and project specifics.
3737

3838
Join our [Discord](https://discord.gg/securityalliance) server, let others know what you are working on in the
39-
frameworks-reviewers’ group channel, and collaborate with other contributors writing about related topics.
39+
`frameworks-contribs` group channel, and collaborate with other contributors writing about related topics.
4040

4141
## Live versions
4242

@@ -62,6 +62,9 @@ PRs or branches to make sure your work has not been previously submitted.
6262
- Use the **“Contribute today!”** button at the bottom of any page
6363
- Make fixes, formatting, and clarifications, favoring major modifications over just a few grammar mistakes
6464
- Changes go through GitHub’s web interface without requiring local setup
65+
- If someone already has an open PR, you can review the Cloudflare Pages preview linked from that PR and leave
66+
proofreading or feedback on the PR itself without opening your own PR. This is a rendered preview for review, not a
67+
separate commenting feature on the live site.
6568

6669
### 2. Add a new section or expand an existing one
6770

@@ -72,13 +75,14 @@ All contributions should follow this workflow:
7275
page** when creating or expanding content. It contains pre-defined components and structure required for consistency
7376
in MDX files.
7477
3. **Make your changes** in MDX (typos, improvements, or new content) on your fork.
75-
4. **Open a Pull Request (PR) against the `develop` branch** of this repository. Once submitted, you can see the
76-
deployment through the automated preview and make any final adjustments.
78+
4. **Open a Pull Request (PR) against the `develop` branch** of this repository. Once submitted, use the Cloudflare
79+
Pages preview linked from the PR to verify the rendered site and make any final adjustments before review. All
80+
feedback and discussion should stay on the PR itself.
7781
5. **Notify reviewers** by tagging a steward or maintainer, requesting reviews directly in your PR.
78-
6. Additionally, you can paste your PR and/or potential associated issues to the `framework-reviewers` Discord channel.
82+
6. Additionally, you can paste your PR and/or potential associated issues to the `frameworks-contribs` Discord channel.
7983
7. Once reviewed and approved, your changes will be merged into `develop`.
8084
8. Don't forget to add yourself to the YAML header of the file you're modifying, given that is the way we provide
81-
attribution. You should also create your profile inside the contributors list, at `docs/config/contributors.json`.
85+
attribution. You should also create your profile inside the contributors list, at `docs/pages/config/contributors.json`.
8286
9. Periodically, reviewed content from `develop` is merged into `main` for the stable site.
8387

8488
If you’re interested in a framework that doesn’t currently have an active steward, you can **become one yourself**. See
@@ -334,8 +338,8 @@ lecture](https://www.youtube.com/watch?v=vtIzMaLkCaM) to get started.
334338
- Consider tutorials or hands-on guides for practical steps.
335339
- Use visualizations (mermaid, diagrams, tables) to clarify concepts.
336340
- Add recommended reading or dependencies at the top of a page if relevant.
337-
- Focus on delivering credible, formal, technical content without unnecessary high-level introductions; use examples, comparisons, or anecdotes to clarify complex topics.
338-
341+
- Focus on delivering credible, formal, technical content without unnecessary high-level introductions; use examples,
342+
comparisons, or anecdotes to clarify complex topics.
339343
- You can use mermaid diagrams for visualizations
340344

341345
### Content standardization

0 commit comments

Comments
 (0)