Skip to content
Merged
Show file tree
Hide file tree
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
45 changes: 30 additions & 15 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ If you'd like to join our effort, feel free to fix typos, contribute new section
[Code of Conduct](https://github.com/security-alliance/frameworks/blob/develop/CODE_OF_CONDUCT.md)**
to ensure that all interactions remain respectful, inclusive, and constructive.

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

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

Expand Down Expand Up @@ -101,7 +104,6 @@ devcontainer exec --workspace-folder . bash
# Get the IP address of the container, by running `hostname -I | awk '{print $1}'`. Should be printed automatically in the terminal after the creation as well
# Inside container: pnpm exec just serve
# Access the docs at http://<IP>:5173

```

### Option C: Local installation
Expand All @@ -118,7 +120,6 @@ If you prefer to install dependencies locally on your machine:
**Setup:**

1. Install all prerequisites listed above

2. Clone the repository:

```bash
Expand Down Expand Up @@ -199,25 +200,38 @@ Or look at your branch on GitHub — commits should show a green **Verified** ba
When contributing to the Security Frameworks, there are several additional responsibilities to ensure your updates
integrate smoothly into the site and maintain proper structure:

### 1. Page tags
### 1. Frontmatter

Every page requires frontmatter at the top of the file. Here are the key fields:

#### Title and Description

Add a title and description to every page you add:

```yaml
---
title: "Your Page Title"
description: "A brief description of the page content."
---
```

#### Tags

- Assign appropriate tags at the top of your pages in the frontmatter to help categorize content by role, topic, or
skill level:
Assign tags to categorize content by role, topic, or skill level:

```yaml
---
tags:
- Engineer/Developer
- Security Specialist
---

```

- Proper tagging makes your contribution discoverable and filterable on the site.
Proper tagging makes your contribution discoverable and filterable on the site.

### 2. Contributors metadata
#### Contributors

- Add yourself and other relevant contributors to the page frontmatter:
Add yourself and other relevant contributors:

```yaml
---
Expand All @@ -227,13 +241,15 @@ contributors:
- role: reviewed
users: [reviewer1, reviewer2]
---

```

- Contributors are **managed centrally**:
1. **Contributor database:** `docs/pages/config/contributors.json`
2. **Usage guide:** `docs/pages/config/using-contributors.mdx`
- This helps track contributions and ensures proper attribution for edits and reviews.
Contributors are **managed centrally**:
- **Contributor database:** `docs/pages/config/contributors.json`
- **Usage guide:** `docs/pages/config/using-contributors.mdx`

This helps track contributions and ensures proper attribution.

For a complete frontmatter example, see the [template file](/docs/pages/config/template.mdx).

### 3. Sidebar / Navigation

Expand Down Expand Up @@ -332,7 +348,6 @@ pie title What Voldemort doesn't have?
- **Incomplete pages** should include a stub notice:

> ⚠️ This article is still in progress. Help the framework by contributing and expanding it.
>

Pages with minimal content which need more work to cover the topic need to include a notice:

Expand Down
3 changes: 2 additions & 1 deletion docs/pages/awareness/core-awareness-principles.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Core Awareness Principles"
title: "Core Awareness Principles | Security Alliance"
description: "Master the Zero Trust Mindset and Threat Recognition principles to defend against phishing, social engineering, and malware. Build a security-conscious culture in your organization."
tags:
- Security Specialist
- Operations & Strategy
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Cultivating A Security Aware Mindset"
title: "Cultivating A Security Aware Mindset | SEAL"
description: "Build security habits with Password Management, Multi-Factor Authentication (MFA), and Incident Response Awareness. Practical tips for Discord, Twitter, and Telegram community settings."
tags:
- Security Specialist
- Operations & Strategy
Expand Down
3 changes: 2 additions & 1 deletion docs/pages/awareness/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Awareness Framework"
title: "Security Awareness | Security Alliance"
description: "Security Awareness Framework: Learn to recognize risk signals and cultivate a security-aware mindset. Protect against Web3 threats like crypto drainers, rug pulls, phishing, and social engineering."
tags:
- Security Specialist
- Operations & Strategy
Expand Down
3 changes: 2 additions & 1 deletion docs/pages/awareness/resources-and-further-reading.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Resources And Further Reading"
title: "Security Resources & Further Reading | SEAL"
description: "Curated Web3 security resources: SANS newsletters, Darknet Diaries podcast, Immunefi learning materials, token approval tools like Unrekt, and recommended password managers like Bitwarden."
tags:
- Security Specialist
- Operations & Strategy
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Staying Informed And Continuous Learning"
title: "Staying Informed And Continuous Learning | SEAL"
description: "Create effective security training with phishing simulations, role-based learning, and SEAL Wargames. Stay current with trusted sources like SANS NewsBites and DeFi Security Summit."
tags:
- Security Specialist
- Operations & Strategy
Expand Down
3 changes: 2 additions & 1 deletion docs/pages/awareness/understanding-threat-vectors.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Understanding Threat Vectors"
title: "Understanding Threat Vectors | Security Alliance"
description: "Identify phishing, vishing, and social engineering attacks. Learn about Web3 threats like crypto drainers, rug pulls, token approval exploits, and smart contract vulnerabilities."
tags:
- Security Specialist
- Operations & Strategy
Expand Down
3 changes: 2 additions & 1 deletion docs/pages/certs/certification-guidelines.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Certification Guidelines"
title: "Certification Guidelines | Security Alliance"
description: "Complete SEAL certification guidelines: self-assessment scoring, third-party review criteria, evidence requirements, and certification process. Validate your protocol's security posture."
tags:
- SEAL/Initiative
- Certifications
Expand Down
3 changes: 2 additions & 1 deletion docs/pages/certs/certified-partners.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Certified Auditors"
title: "Certified Auditors | Security Alliance"
description: "Become a SEAL-certified auditor: demonstrate blockchain security expertise, conduct audits against SEAL Certification Framework, and issue on-chain attestations."
tags:
- SEAL/Initiative
- Certifications
Expand Down
3 changes: 2 additions & 1 deletion docs/pages/certs/certified-protocols.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Certified Protocols"
title: "Certified Protocols | Security Alliance"
description: "Certified protocols with SEAL attestations and on-chain attestations via the Ethereum Attestation Service (EAS)."
tags:
- SEAL/Initiative
- Certifications
Expand Down
3 changes: 2 additions & 1 deletion docs/pages/certs/contributions.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Contributions"
title: "Contributing to SEAL Certifications | Security Alliance"
description: "Contribute to SEAL Certifications: suggest improvements, propose new certifications, or become a SEAL-approved auditor."
tags:
- SEAL/Initiative
- Certifications
Expand Down
3 changes: 2 additions & 1 deletion docs/pages/certs/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Overview"
title: "SEAL Certification Framework | Security Alliance"
description: "SEAL Certification Framework: Modular security certifications for DeFi protocols with standardized evaluation criteria and on-chain attestations."
tags:
- SEAL/Initiative
- Certifications
Expand Down
3 changes: 2 additions & 1 deletion docs/pages/certs/sfc-dns-registrar.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "DNS Registrar"
title: "SFC: DNS Registrar | Security Alliance"
description: "SFC DNS Registrar certification: domain management, registrar access controls, DNSSEC configurations, email authentication (SPF/DKIM/DMARC), monitoring, and incident response."
tags:
- SEAL/Initiative
- Certifications
Expand Down
3 changes: 2 additions & 1 deletion docs/pages/certs/sfc-incident-response.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Incident Response"
title: "SFC: Incident Response | Security Alliance"
description: "SFC Incident Response certification: team roles, 24/7 monitoring, paging systems, response playbooks, signer coordination, emergency communications, and regular drills."
tags:
- SEAL/Initiative
- Certifications
Expand Down
3 changes: 2 additions & 1 deletion docs/pages/certs/sfc-multisig-ops.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Multisig Operations"
title: "SFC: Multisig Operations | Security Alliance"
description: "SFC Multisig Operations certification: governance, signer security, transaction verification, emergency playbooks, communication protocols, and 24/7 paging for critical multisigs."
tags:
- SEAL/Initiative
- Certifications
Expand Down
3 changes: 2 additions & 1 deletion docs/pages/certs/sfc-treasury-ops.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Treasury Operations"
title: "SFC: Treasury Operations | Security Alliance"
description: "SFC Treasury Operations certification: governance, access control, transaction verification, DeFi risk assessment, staking security, monitoring, and vendor management."
tags:
- SEAL/Initiative
- Certifications
Expand Down
3 changes: 2 additions & 1 deletion docs/pages/certs/sfc-workspace-security.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Workspace Security"
title: "SFC: Workspace Security | Security Alliance"
description: "SFC Workspace Security certification: device management, account security, credential handling, network security, employee training, and insider threat assessment."
tags:
- SEAL/Initiative
- Certifications
Expand Down
3 changes: 2 additions & 1 deletion docs/pages/community-management/discord.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Discord Security"
title: "Discord Security | Security Alliance"
description: "Secure your Discord server against raids and phishing with 2FA for moderation, Raid Protection, Auto-Moderation Rules, Cold Admin Accounts, and anti-impersonation bots like Wick."
tags:
- Community & Marketing
- Security Specialist
Expand Down
3 changes: 2 additions & 1 deletion docs/pages/community-management/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Community Management"
title: "Community Management | Security Alliance"
description: "Community Management Framework: Secure your Web3 community on Telegram, Discord, and X (Twitter). Essential practices for 2FA, phishing prevention, and emergency response planning."
tags:
- Community & Marketing
contributors:
Expand Down
3 changes: 2 additions & 1 deletion docs/pages/community-management/telegram.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Telegram"
title: "Telegram Security | Security Alliance"
description: "Secure Telegram against SIM swapping and Man-in-the-Group attacks. Configure Two-Step Verification, hide your phone number, use Secret Chats with end-to-end encryption, and manage admin permissions."
tags:
- Community & Marketing
contributors:
Expand Down
3 changes: 2 additions & 1 deletion docs/pages/community-management/twitter.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Twitter"
title: "Twitter/X Security | Security Alliance"
description: "Protect your X (Twitter) account from SIM swapping: remove your phone number, enable 2FA with authenticator app or security key, and enable password reset protection."
tags:
- Community & Marketing
contributors:
Expand Down
3 changes: 3 additions & 0 deletions docs/pages/config/template.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
title: "Template"
# SEO meta description: 140-160 chars. Start with the framework/topic name, include
# searchable terms (tool names, attack types, standards), use action verbs.
description: "Replace this with a concise summary of the page content. Include searchable keywords relevant to security researchers and whitehats."
tags:
- Security Specialist
- Operations & Strategy
Expand Down
54 changes: 43 additions & 11 deletions docs/pages/contribute/contributing.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Contribute"
title: "Contributing Guide | Security Alliance"
description: "Contribute to SEAL Security Frameworks: fix typos, add new sections, or propose enhancements. Help us build the documentation and improve security in the blockchain ecosystem"
---

{/*
Expand Down Expand Up @@ -211,11 +212,39 @@ Or look at your branch on GitHub — commits should show a green **Verified** ba
When contributing to the Security Frameworks, there are several additional responsibilities to ensure your updates
integrate smoothly into the site and maintain proper structure:

### 1. Page tags
### 1. Frontmatter

- Assign appropriate tags at the top of your pages in the frontmatter to help categorize content by role, topic, or
Every page requires frontmatter at the top of the file. Here are the key fields:

skill level:
#### Title and Description

Add a title and description to every page you add:

```yaml
---
title: "Your Page Title | Security Alliance"
# SEO meta description: 140-160 chars. Start with the framework/topic name, include
# searchable terms (tool names, attack types, standards), use action verbs.
description: "Your description here, 140-160 characters."
---
```

**Titles** should be concise and descriptive—avoid generic names like "Overview" or "Guide" alone.
Use "Preparing for a Smart Contract Audit" instead of "Preparation". Keep titles under 60 characters
(including the `| Security Alliance` suffix) so they display fully in search results. If your title
is too long, use `| SEAL` instead.

**Meta descriptions** appear in search results and determine whether researchers click through.
Aim for 140-160 characters, include searchable terms whitehats use (tool names, attack types,
standards), and use action verbs. See
[Google's guide](https://developers.google.com/search/docs/appearance/snippet) for more details.

- ✅ `"Smart contract audits: scoping, static analysis, manual review, and formal verification."`
- ❌ `"This page covers security topics."` (too vague, no searchable terms)

#### Tags

Assign tags to categorize content by role, topic, or skill level:

```yaml
---
Expand All @@ -225,11 +254,11 @@ tags:
---
```

- Proper tagging makes your contribution discoverable and filterable on the site.
Proper tagging makes your contribution discoverable and filterable on the site.

### 2. Contributors metadata
#### Contributors

- Add yourself and other relevant contributors to the page frontmatter:
Add yourself and other relevant contributors:

```yaml
---
Expand All @@ -241,10 +270,13 @@ contributors:
---
```

- Contributors are **managed centrally**:
1. **Contributor database:** `docs/pages/config/contributors.json`
2. **Usage guide:** `docs/pages/config/using-contributors.mdx`
- This helps track contributions and ensures proper attribution for edits and reviews.
Contributors are **managed centrally**:
- **Contributor database:** `docs/pages/config/contributors.json`
- **Usage guide:** `docs/pages/config/using-contributors.mdx`

This helps track contributions and ensures proper attribution.

For a complete frontmatter example, see the [template file](https://github.com/security-alliance/frameworks/blob/develop/docs/pages/config/template.mdx?plain=1).

### 3. Sidebar / Navigation

Expand Down
3 changes: 2 additions & 1 deletion docs/pages/contribute/spotlight-zone.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Spotlight Zone"
title: "Spotlight Zone | Security Alliance"
description: "Recognition for individuals who have made substantial contributions to SEAL Security Frameworks. View our contributors and their impactful work."
---
import { Contributors, ContributeFooter, TagFilter, TagProvider } from '../../../components'

Expand Down
3 changes: 2 additions & 1 deletion docs/pages/contribute/stewards.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Stewardship"
title: "Becoming a Framework Steward | Security Alliance"
description: "Become a SEAL Framework Steward: champion and caretake a security framework. Rally collaborators, manage contributions, advocate for adoption, and shape Web3 security standards."
---
import { ContributeFooter, TagFilter, TagProvider } from '../../../components'

Expand Down
3 changes: 2 additions & 1 deletion docs/pages/devsecops/code-signing.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Code Signing"
title: "Implementing Code Signing | Security Alliance"
description: "Verify code integrity with GPG-signed Pull Requests. Best practices for Multi-Factor Authentication (MFA) with Yubikeys, mandatory code reviews, and regular GPG key rotation."
tags:
- Engineer/Developer
- Security Specialist
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Continuous Integration Continuous Deployment"
title: "Securing CI/CD Pipelines | SEAL"
description: "Build secure CI/CD pipelines with GitHub Actions: unit tests, integration tests, vulnerability scanning, deterministic builds, and strict access controls for pipeline configurations."
tags:
- Engineer/Developer
- Security Specialist
Expand Down
3 changes: 2 additions & 1 deletion docs/pages/devsecops/integrated-development-environments.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Integrated Development Environments"
title: "Securing Development Environments | SEAL"
description: "Secure your IDE with plugins from trusted sources only, restricted mode for untrusted projects, static code analysis tools, and isolation from production environments."
tags:
- Engineer/Developer
- Security Specialist
Expand Down
Loading