Skip to content

Commit 11c1332

Browse files
mattaereal00xWizardscode2277shortdoomnbelenkov
authored
Monthly update & migration (mdbook -> vocs) (#255)
* Incident management playbook (#224) * Create README.md * Incident-Response-Playbooks * removed yaml review part * Update malware.md * Update hacked-dprk.md * Update hacked-drainer.md * Update hacked-elusive-comet.md * updated SUMMARY.develop & deleted resources * Update SUMMARY.md.develop Fixed the playbooks indentation * Update SUMMARY.md.develop * typo & capitalization fixed * Incident management playbooks (#233) * incident-management/playbooks improvements * fix SUMMARY.develop * Vocs Migration (#227) * initial Vocs migration and Vercel-ready devcontainer setup - Configured devcontainer and npm scripts with host 0.0.0.0 and port 5173 forwarding - Added vercel_build.sh and vercel.json to enable Vercel deployment - Retained src folder for easier future migration and modular structure - Included initial theme files for later customization * .gitignore updated to show package.json and package-lock.json * Update .gitignore to remove the build folder * Remove dist folder from tracking * completed migration of content to MDX format and restructured navigation - Migrated all files from src/ to docs/pages/ and converted .md to .mdx - Added proper TagProvider components and frontmatter - Updated vocs.config.ts with completed navigation - Removed src/ folder as content migration is complete * fix: resolve dead links and update opsec structure * feat: sync contributors.json with complete contributor metadata * feat: added contributors.mdx component + footer component * fix: added missing import * feat: Update filter component to automatically fetch tags from frontmatter * Update filter to be static + responsive * fix: update filter position if the banner is present + filter theming * feat: sidebar filter and docs cleanup - update blockchain tag color - make sidebar scrollable when filter is open - remove old SUMMARY files - add new manual-review page - reorganize public folder with images in subfolders - remove landing page - add branch-based sidebar filter in vocs.config.ts * fix(build): add Playwright installation in Vercel build for Mermaid rendering * chore(docs): comment out mermaid diagram to isolate build issue * fix(build): force Playwright installation in Vercel build * chore(build): manual Playwright download for Vercel * feat: Add mermaid component * refactor(docs): reorganize contributors positioning + rename stewards&contributors files * feat: integrate main/develop changes, global styling and sets up npm for just commands * Add missing contributors to contributors.json * fix: fixing typos * feat: Add insider-threats framework (DPRK IT Workers) (#193) * feat: Add insider-threats framework (DPRK IT Workers) Signed-off-by: blackbigswan <56428630+shortdoom@users.noreply.github.com> * feat: Fixing based on comments Signed-off-by: blackbigswan <56428630+shortdoom@users.noreply.github.com> --------- Signed-off-by: blackbigswan <56428630+shortdoom@users.noreply.github.com> * Addition of a Mutation Testing Section (#180) * mutation testing section Added: - Mutation Testing Section - Reference to Mutation Testing in Unit Testing * changes based on PR feedback Co-authored-by: Patrick Collins <54278053+PatrickAlphaC@users.noreply.github.com> * Moved the evaluating test suite part to Readme * updated summary as requested * Fixing the linter to take into account subfolders as well (#191) * Fixing the linter to take into account subfolders as well * Mass fixing linting * fixing linting in justfile * Update src/external-security-reviews/README.md Co-authored-by: Dickson Wu <33645481+DicksonWu654@users.noreply.github.com> --------- Co-authored-by: Dickson Wu <33645481+DicksonWu654@users.noreply.github.com> * Update SUMMARY.md.develop --------- Co-authored-by: Patrick Collins <54278053+PatrickAlphaC@users.noreply.github.com> Co-authored-by: Matías Aereal Aeón <388605+mattaereal@users.noreply.github.com> Co-authored-by: Dickson Wu <33645481+DicksonWu654@users.noreply.github.com> * Merge from Main * Merge from main * Update SUMMARY.md.main with new prod-ready pages * Updating main on missing commits due to previous selective-merging (#192) * Code review additions (#145) * add pre-audit prep stage with links to solcurity and simple security toolkit Signed-off-by: Elliot <elliotfriedman3@gmail.com> * add prepare thoroughly section Signed-off-by: Elliot <elliotfriedman3@gmail.com> * prepare thoroughly -> come prepared Signed-off-by: Elliot <elliotfriedman3@gmail.com> --------- Signed-off-by: Elliot <elliotfriedman3@gmail.com> * Updated contributing and readme.md * Removed catpuccin, updated mdbook and admonish. (#147) * Removed catpuccin, updated mdbook and admonish. * Removing deprecated themes from UI, and fixing admonish version on vercel_build * Testing admonish through vercel automated deployment * Updating wordlist.txt * Clean update of logo and favicon. (#151) * Updating develop to the new and more humane beginning of a written Opsec Framework (#154) * Updating Opsec first iteration after re-write, CorPrinciples checkpoint * Updating Opsec structure and initial approach for some of the new contents. * Updating human centered security * Stop tracking generated tagsindex.js file * Updating gitignore * Removing old readme that explained how tags work. * New structure * First iter of Fundamentals * First iter of Fundamentals * Restructuring Opsec once again. Re-wrtitten principles and threat modeling * Forgot attribution. * Added key takeaways and removed redundancy * Updating Risk management and removing overlap from Threat modeling * Fixing broken link * Spellcheck's wordlist update * Spellcheck's wordlist update * Spellcheck's wordlist update * Updating Opsec with latest updates (#157) * Updating Opsec first iteration after re-write, CorPrinciples checkpoint * Updating Opsec structure and initial approach for some of the new contents. * Updating human centered security * Stop tracking generated tagsindex.js file * Updating gitignore * Removing old readme that explained how tags work. * New structure * First iter of Fundamentals * First iter of Fundamentals * Restructuring Opsec once again. Re-wrtitten principles and threat modeling * Forgot attribution. * Added key takeaways and removed redundancy * Updating Risk management and removing overlap from Threat modeling * Fixing broken link * Spellcheck's wordlist update * Spellcheck's wordlist update * Spellcheck's wordlist update * Updating with tincho's review * Fixing grammar issues and spellcheck * Updating wordlist.txt * Initial draft of personal security travel guide! (#158) * Updating Opsec first iteration after re-write, CorPrinciples checkpoint * Updating Opsec structure and initial approach for some of the new contents. * Updating human centered security * Stop tracking generated tagsindex.js file * Updating gitignore * Removing old readme that explained how tags work. * New structure * First iter of Fundamentals * First iter of Fundamentals * Restructuring Opsec once again. Re-wrtitten principles and threat modeling * Forgot attribution. * Added key takeaways and removed redundancy * Updating Risk management and removing overlap from Threat modeling * Fixing broken link * Spellcheck's wordlist update * Spellcheck's wordlist update * Spellcheck's wordlist update * Updating with tincho's review * Fixing grammar issues and spellcheck * Updating wordlist.txt * Security travel guide from Notion * Attribution * Updating naming on opsec travel guide * Updating, and re-ordering paragraphs from opsec travel guide * Attribution to sources * Add Secure Multisig Signing Process (#122) * Add secure multisig signing process * Add multisig best practices page, update msig signing process * Add additional best practices from EF doc * Add final comment for this PR * Removing the old operational-security folder, moving secure-multisig contents within wallet-security, and re-generated the overview of frameworks with AI. * Safe Harbor Docs (#144) Co-authored-by: Matías Aereal Aeón <388605+mattaereal@users.noreply.github.com> * doc: instruction for re-writing history to sign commits (#156) * Tidy plugins (#143) * Tody Plugins Signed-off-by: Robert MacWha <trebor.ahwcam@gmail.com> * doc: fix robert's website --------- Signed-off-by: Robert MacWha <trebor.ahwcam@gmail.com> * feat: overhaul of the Wallet Security section (#164) * docs: update README for new structure * docs: update documentation on custodial vs non-custodial and hot vs cold wallets * docs: add user security guides for beginners and intermediates * docs: add advanced security guides * docs: add key management * docs: add tools and resources * docs: add signing and verifation section * docs: improvements in AA and EIP7701 * docs: improves the entire section * docs: deletion of obsolete sections * docs: add new item hardwallet * docs: fixed typo * docs: Refine wallet security guides for accuracy and clarity * docs: Apply light content adjustments and add 'reviewed' tag. * archive Developer Key Management section for later * small format changes * docs: refactor updated navigation * docs: Update contribution and documentation configuration * feat: fix extra fields & add verbose errors (#167) * feat: fix extra fields & add verbose errors * fix: switch back to book.for_each_mut Also cache all errors instead of just the first * feat: log error when deserializing contributors json * feat: fix UI differences * fix: re-add company attribution * fix: add alias for fact-checked * fix: jitter on hover contributors * fix: urls scrolling * fix: display:content * fix: `fact_checked` spelling * fix: throw error if role alias not found * tidy: role_aliases * Bump crossbeam-channel (#166) Bumps the cargo group with 1 update in the /plugin/mdbook-metadata directory: [crossbeam-channel](https://github.com/crossbeam-rs/crossbeam). Updates `crossbeam-channel` from 0.5.14 to 0.5.15 - [Release notes](https://github.com/crossbeam-rs/crossbeam/releases) - [Changelog](https://github.com/crossbeam-rs/crossbeam/blob/master/CHANGELOG.md) - [Commits](crossbeam-rs/crossbeam@crossbeam-channel-0.5.14...crossbeam-channel-0.5.15) --- updated-dependencies: - dependency-name: crossbeam-channel dependency-version: 0.5.15 dependency-type: indirect dependency-group: cargo ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Fix several misc (#168) * Added some things to gitignore, particularly to use claude. * Correcting attribution * Updating steward, and improving tags UI * Removing spell-check from develop. Only on main from now on. Exploratory. * feat: security testing - solidity focused (#163) * feat: security testing - solidity focused * fix: lint * fix: josselins review * fix: reverse aderyn and slither order * fix: patrickalphac contributor after merge * Introducing Decentralized IR Framework (#165) * added DeIRF framework * new de-irf framework * adjusted summary as requested --------- Co-authored-by: Ken Toler <ken.toler@gmail.com> * feat: external security reviews & patrick addition (#160) * feat: external security reviews & patrick addition * fix: lint * fix: moved smart contract audits to their own section * Adding to the outline the latest pushed content. * Bump mdbook version (#177) * Update vercel_build.sh * Update printed statement * feat: added more information on wallet security (#173) * feat: added more information on wallet security * fix: remove named solutions * Update PULL_REQUEST_TEMPLATE.md (#174) * fix: stewards (#172) * Update tldr.md (#181) Added a line to "While Traveling" * Update README.md (#178) I improved clarity in OpSec overview with simplified explanation and added detail on goal * Update implementation-process.md (#179) Fixed punctuation to make the text clearer, added colons, commas, and cleaned up brackets. * feat: updating linting, devcontainer, and local development (#184) * feat: updating linting, devcontainer, and local development * Update justfile --------- Co-authored-by: Matías Aereal Aeón <388605+mattaereal@users.noreply.github.com> * Going back to 0.4.40 stable. * Fix spelling issues and update wordlist (#188) - Fixed 'asume' -> 'assume' in src/opsec/travel/guide.md - Fixed 'cybercrmiminals' -> 'cybercriminals' in src/opsec/travel/guide.md - Added 78 legitimate technical terms, brand names, and valid words to wordlist.txt - Includes terms like Counterparty, Invariants, Utils, and many others - Cleaned up wordlist formatting and removed invalid entries * Fix typos in mdbook-metadata README.md and add renderer to wordlist - Fix 'pagse' to 'pages' - Fix 'requrie' to 'require' - Fix 'seperate' to 'separate' - Add 'renderer' to wordlist.txt * Update threat-modeling-overview.md (#182) * Clarified 'Team changes' to include onboarding and offboarding key personnel * Added structured 'Further Reading & Tools' section with grouped references and tools * Updating Safe Harbor Documentation (#186) * Enhance Safe Harbor documentation and contributor list - Updated SUMMARY.md to include new resources for Safe Harbor, such as self-checklists and adoption guides. - Removed outdated key terms and protocol documentation from the Safe Harbor section. - Expanded the README.md to provide clearer explanations of Safe Harbor's purpose, adoption process, and benefits, including new visuals and testimonials from industry leaders. - Added Dickson Wu as a contributor in contributors.json with relevant details. * Update Safe Harbor documentation links for consistency - Changed links in various templates and guides to point to local markdown files instead of external Notion pages for better accessibility. - Updated the adoption details in the DAO proposal and non-DAO scope templates to reflect the new link structure. - Revised the self-adoption guide and checklist to ensure all references are consistent with the new documentation format. * Update Safe Harbor section in SUMMARY.md with new resources - Added links to new documentation including self-checklist, self-adoption guide, scope terms, on-chain adoption guide, DAO proposal template, and non-DAO scope template. - Removed outdated protocol and key terms links for improved clarity and organization. * Refactor Safe Harbor documentation for clarity and consistency - Updated the Safe Harbor eligibility checklist title and content for improved clarity. - Added new tags to various templates to enhance categorization. - Revised contact information in multiple documents to use a unified email format. - Ensured all references to Safe Harbor align with the latest documentation standards. * Update src/config/contributors.json Co-authored-by: Robert MacWha <trebor.ahwcam@gmail.com> * Remove integration mapping documentation file * Update src/safe-harbor/README.md Co-authored-by: Robert MacWha <trebor.ahwcam@gmail.com> * Update src/safe-harbor/scope-terms.md Co-authored-by: Robert MacWha <trebor.ahwcam@gmail.com> * Update src/safe-harbor/self-checklist.md Co-authored-by: Robert MacWha <trebor.ahwcam@gmail.com> * Update src/safe-harbor/on-chain-adoption-guide.md Co-authored-by: Robert MacWha <trebor.ahwcam@gmail.com> * Update src/safe-harbor/README.md Co-authored-by: Robert MacWha <trebor.ahwcam@gmail.com> * Update src/safe-harbor/scope-terms.md Co-authored-by: Robert MacWha <trebor.ahwcam@gmail.com> * Remove DAO Proposal and Non-DAO Scope Templates from Safe Harbor documentation - Deleted the DAO Proposal Template and Non-DAO Scope Template files to streamline the Safe Harbor resources. - Updated SUMMARY.md and config/SUMMARY.md.develop to reflect the removal of these templates, enhancing clarity and organization. * Refactor Safe Harbor documentation for clarity and consistency - Removed unnecessary horizontal lines from multiple sections in the on-chain adoption guide, scope terms, self-adoption guide, and self-checklist to improve readability. - Enhanced the overall structure of the documents by streamlining formatting. --------- Co-authored-by: Robert MacWha <trebor.ahwcam@gmail.com> * Updating outlines. Removing empty frameworks from main * Fixing broken link in PR template * Fixing grammar issues and spellcheck --------- Signed-off-by: Elliot <elliotfriedman3@gmail.com> Signed-off-by: Robert MacWha <trebor.ahwcam@gmail.com> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Elliot <34463580+ElliotFriedman@users.noreply.github.com> Co-authored-by: engn33r <engn33r@users.noreply.github.com> Co-authored-by: Robert MacWha <trebor.ahwcam@gmail.com> Co-authored-by: Piña <32434364+pinalikefruit@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Patrick Collins <54278053+PatrickAlphaC@users.noreply.github.com> Co-authored-by: relotnek <kentoler@gmail.com> Co-authored-by: Ken Toler <ken.toler@gmail.com> Co-authored-by: David <100804766+davidthegardens@users.noreply.github.com> Co-authored-by: NFTDreww <158506653+NFTDreww@users.noreply.github.com> Co-authored-by: Godwin Udo <102424075+GodwinDA@users.noreply.github.com> Co-authored-by: Yasir <100064629+damboy0@users.noreply.github.com> Co-authored-by: Dickson Wu <33645481+DicksonWu654@users.noreply.github.com> * quick fix for external security reviews * Adding dobs suggestions * Add Yaniv Sofer as a contributor and update review roles in insider t… (#221) * Add Yaniv Sofer as a contributor and update review roles in insider threats documentation * Add blackbigswan as a contributor and update contributor roles in insider threats documentation * fix: naming change - explicit DPRK IT Workers framework (#223) * fix: changed name of "insider-threats" folder to "dprk-it-workers" * fix: folder name change + delete src folder * Rename README files to "overview" for consistency * Rename opsec/overview folder to core-concepts * merge opsec/core-concepts/overview into opsec/overview * make vercel redirect parent URLs on their overview file * light mode adjustments * fix formatting * fix height image --------- Signed-off-by: blackbigswan <56428630+shortdoom@users.noreply.github.com> Signed-off-by: Elliot <elliotfriedman3@gmail.com> Signed-off-by: Robert MacWha <trebor.ahwcam@gmail.com> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: blackbigswan <56428630+shortdoom@users.noreply.github.com> Co-authored-by: Nikita Belenkov <nikitov603@gmail.com> Co-authored-by: Patrick Collins <54278053+PatrickAlphaC@users.noreply.github.com> Co-authored-by: Matías Aereal Aeón <388605+mattaereal@users.noreply.github.com> Co-authored-by: Dickson Wu <33645481+DicksonWu654@users.noreply.github.com> Co-authored-by: Robert MacWha <trebor.ahwcam@gmail.com> Co-authored-by: Elliot <34463580+ElliotFriedman@users.noreply.github.com> Co-authored-by: engn33r <engn33r@users.noreply.github.com> Co-authored-by: Piña <32434364+pinalikefruit@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: relotnek <kentoler@gmail.com> Co-authored-by: Ken Toler <ken.toler@gmail.com> Co-authored-by: David <100804766+davidthegardens@users.noreply.github.com> Co-authored-by: NFTDreww <158506653+NFTDreww@users.noreply.github.com> Co-authored-by: Godwin Udo <102424075+GodwinDA@users.noreply.github.com> Co-authored-by: Yasir <100064629+damboy0@users.noreply.github.com> Co-authored-by: matta <matt@theredguild.org> * Restructure README.md and CONTRIBUTING.md (#225) * Update README.md * Create CONTRIBUTING.md at root level to make it appear in the main dashboard's navbar * Update contributing.md in the src folder to mirror the CONTRIBUTING.md at root level * Update links in README.md * Add "Fixing Unsigned Commits" section to root level CONTRIBUTING.md * Add "Fixing Unsigned Commits" section to src/contribute/CONTRIBUTING.md * Minor improvements to contributing.md * Update README.md * Update CODE_OF_CONDUCT.md * Update CODE_OF_CONDUCT.md * Update CODE_OF_CONDUCT.md * fix comment docs/pages/contributing.mdx * fix indentation of code blocks * fix typos + align root level CONTRIBUTING.md with docs/contribute/contributing.mdx * vocs alignment * fix typos in CODE_OF_CONDUCT * fix: add Mermaid component for mermaid code block display * fix frontmatter positioning --------- Co-authored-by: Matías Aereal Aeón <388605+mattaereal@users.noreply.github.com> * Fix logo path in README.md (#237) * Update README.md * Update styles.css * Updating telegram's device setting (#243) * Update PULL_REQUEST_TEMPLATE.md to feature the vocs migration (#245) * Bump vite in the npm_and_yarn group across 1 directory (#234) Bumps the npm_and_yarn group with 1 update in the / directory: [vite](https://github.com/vitejs/vite/tree/HEAD/packages/vite). Updates `vite` from 6.3.5 to 6.3.6 - [Release notes](https://github.com/vitejs/vite/releases) - [Changelog](https://github.com/vitejs/vite/blob/v6.3.6/packages/vite/CHANGELOG.md) - [Commits](https://github.com/vitejs/vite/commits/v6.3.6/packages/vite) --- updated-dependencies: - dependency-name: vite dependency-version: 6.3.6 dependency-type: indirect dependency-group: npm_and_yarn ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * feat: Benchmark component (#241) * feat: create mermaid wrapper script (#242) * chore(images): migrate all images to S3 (#252) * update image links in safe-harbor/overview.mdx * Removing safe-harbor images * update logo links + delete public folder * fix: CONTRIBUTING.md + contributing.mdx (#250) * add error-checking step before pushing changes to CONTRIBUTING.md * add error-checking step before pushing changes to contributing.mdx * add port of local run + fixed a typo in CONTRIBUTING.md * add port of local run + fixed a typo in contributing.mdx * Fix link paths, typos, and indentation in contributing.mdx * Update contributing.mdx to sync with root level CONTRIBUTING file * Fix link paths, typos, and indentation in CONTRIBUTING.md * chore: update tags (#253) * fix(flickering on reload): remove redirects from vercel.json (#249) * fix(theme): prevent light flash by defaulting to dark mode * fix table of content margin * feat: add theme toggle component * chore: removed the vercel's redirects + the default dark mode * remove tags updates * chore(spellcheck): migrate from Aspell to CSpell (#251) * chore(spellcheck): migrate from Aspell to CSpell + fix typos * fix: removed unnecessary dictionaries --------- Signed-off-by: blackbigswan <56428630+shortdoom@users.noreply.github.com> Signed-off-by: Elliot <elliotfriedman3@gmail.com> Signed-off-by: Robert MacWha <trebor.ahwcam@gmail.com> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: 00xWizard <00xwizard@gmail.com> Co-authored-by: Sara Russo <sararusso984@gmail.com> Co-authored-by: blackbigswan <56428630+shortdoom@users.noreply.github.com> Co-authored-by: Nikita Belenkov <nikitov603@gmail.com> Co-authored-by: Patrick Collins <54278053+PatrickAlphaC@users.noreply.github.com> Co-authored-by: Dickson Wu <33645481+DicksonWu654@users.noreply.github.com> Co-authored-by: Robert MacWha <trebor.ahwcam@gmail.com> Co-authored-by: Elliot <34463580+ElliotFriedman@users.noreply.github.com> Co-authored-by: engn33r <engn33r@users.noreply.github.com> Co-authored-by: Piña <32434364+pinalikefruit@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: relotnek <kentoler@gmail.com> Co-authored-by: Ken Toler <ken.toler@gmail.com> Co-authored-by: David <100804766+davidthegardens@users.noreply.github.com> Co-authored-by: NFTDreww <158506653+NFTDreww@users.noreply.github.com> Co-authored-by: Godwin Udo <102424075+GodwinDA@users.noreply.github.com> Co-authored-by: Yasir <100064629+damboy0@users.noreply.github.com> Co-authored-by: Antonio Viggiano <agfviggiano@gmail.com>
1 parent cb561b4 commit 11c1332

365 files changed

Lines changed: 20470 additions & 7978 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.devcontainer/Dockerfile

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ RUN apt-get update && apt-get install -y \
66
build-essential \
77
pkg-config \
88
libssl-dev \
9-
aspell \
10-
aspell-en \
119
curl \
1210
&& apt-get clean \
1311
&& rm -rf /var/lib/apt/lists/*
@@ -19,15 +17,6 @@ RUN curl -fsSL https://deb.nodesource.com/setup_20.x | bash - \
1917
# Switch to vscode user
2018
USER vscode
2119

22-
# Install Rust and Cargo for vscode user
23-
RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
24-
ENV PATH="/home/vscode/.cargo/bin:${PATH}"
25-
26-
# Install mdBook and mdbook-admonish
27-
RUN /home/vscode/.cargo/bin/cargo install mdbook mdbook-admonish
28-
29-
# Install just command runner
30-
RUN /home/vscode/.cargo/bin/cargo install just
3120

3221
# Install markdownlint-cli2 globally via npm (need root for global install)
3322
USER root
@@ -38,6 +27,3 @@ USER vscode
3827

3928
# Set working directory
4029
WORKDIR /workspace
41-
42-
# Ensure cargo is in PATH for vscode user
43-
RUN echo 'export PATH="/home/vscode/.cargo/bin:$PATH"' >> /home/vscode/.bashrc

.devcontainer/devcontainer.json

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,9 @@
1212
"vscode": {
1313
"extensions": [
1414
"yzhang.markdown-all-in-one",
15-
"rust-lang.rust-analyzer",
16-
"tamasfe.even-better-toml"
15+
"bradlc.vscode-tailwindcss",
16+
"ms-vscode.vscode-typescript-next",
17+
"esbenp.prettier-vscode"
1718
],
1819
"settings": {
1920
"terminal.integrated.defaultProfile.linux": "bash",
@@ -26,9 +27,9 @@
2627
}
2728
},
2829
"forwardPorts": [
29-
3000
30+
5173
3031
],
3132
"workspaceMount": "source=${localWorkspaceFolder},target=/workspace,type=bind,consistency=cached",
3233
"workspaceFolder": "/workspace",
33-
"postCreateCommand": "echo 'DevContainer ready! Run \"just serve\" to start the mdBook server.' && ip=$(hostname -I | awk '{print $1}'); echo \"After running 'just serve', access the mdBook at http://$ip:3000\""
34+
"postCreateCommand": "echo 'DevContainer ready! Run \"npm run docs:dev -- --host port 5173\" to start the Vocs server.' && ip=$(hostname -I | awk '{print $1}'); echo \"After running 'npm run docs:dev', access the site at http://$ip:5173\""
3435
}

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
11
## Frameworks PR Checklist
22

3-
Thank you for contributing to the Security Frameworks! Before you open a PR, make sure to read [information for contributors](https://frameworks.securityalliance.dev/contribute/contributing.html) and take a look at the following checklist:
3+
Thank you for contributing to the Security Frameworks! Before you open a PR, make sure to read [information for contributors](https://frameworks.securityalliance.dev/contribute/contributing) and take a look at the following checklist:
44

55
- [ ] Describe your changes, substitute this text with the information
66
- [ ] If you are touching an existing piece of content, tag current contributors from the attribution list
77
- [ ] If there is a steward for that framework, ask the steward to review it
8-
- [ ] If you're modifying the general outline, make sure to use `src/config/SUMMARY.develop` and not `src/SUMMARY.md`
8+
- [ ] If you're modifying the general outline, make sure to update it in the `vocs.config.ts` adding the `dev: true` parameter
99
- [ ] If you need feedback for your content from the wider community, share the PR in our Discord
1010
- [ ] Review changes to ensure there are no typos, see instructions below
1111

1212
<!--
1313
ℹ️ Checking for typos locally
14-
1. Install [aspell](https://www.gnu.org/software/aspell/) for your platform.
15-
2. Install [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2)
16-
3. Install [just](https://github.com/casey/just)
17-
4. Run `just lint`
14+
1. Install [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2)
15+
2. Install [just](https://github.com/casey/just)
16+
3. Run `npx just lint`
1817
-->

.github/workflows/spell-check.yml

Lines changed: 25 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -22,37 +22,31 @@ jobs:
2222
ref: ${{ github.event.pull_request.head.sha }}
2323
fetch-depth: 2
2424

25-
- name: Install aspell
26-
run: sudo apt-get update && sudo apt-get install -y aspell
27-
28-
- name: Find and check typos in Markdown files
25+
- name: Find and check typos in mdx files
2926
id: find_typos
3027
run: |
3128
echo "Checking for typos..."
32-
# https://unix.stackexchange.com/a/9500
33-
IFS=$'\n'
34-
set -f
35-
for file in $(find . -name "*.md" ); do
36-
output="$(aspell --lang=en_US --mode=markdown --home-dir=. --personal=wordlist.txt --ignore-case=true --camel-case list <$file)"
37-
echo "$output"
38-
# Exit if aspell has errors
39-
if [ $? -ne 0 ]; then
40-
exit 1
41-
fi
42-
if [[ -n "$output" ]]; then
43-
# Format output.
44-
output=$(echo "$output" | sed 's/^/ 1. /')
45-
TYPOS+="- 📄 $file:"
46-
TYPOS+=$'\n'
47-
TYPOS+="$output"
48-
TYPOS+=$'\n'
49-
fi
50-
done
51-
{
52-
echo 'TYPOS<<EOF'
53-
echo "$TYPOS"
54-
echo EOF
55-
} >> "$GITHUB_ENV"
29+
set -o pipefail
30+
# Run cspell and capture output, but don't fail yet
31+
output=$(npx cspell lint "docs/pages/**/*.mdx" --no-progress --no-summary || true)
32+
33+
if [[ -n "$output" ]]; then
34+
echo "Typos found, formatting output..."
35+
formatted=$(echo "$output" | nl -w2 -s'. ')
36+
TYPOS+="- 📄 docs/pages:"
37+
TYPOS+=$'\n'
38+
TYPOS+='```'
39+
TYPOS+=$'\n'
40+
TYPOS+="$formatted"
41+
TYPOS+=$'\n'
42+
TYPOS+='```'
43+
TYPOS+=$'\n\n'
44+
{
45+
echo 'TYPOS<<EOF'
46+
echo "$TYPOS"
47+
echo EOF
48+
} >> "$GITHUB_ENV"
49+
fi
5650
5751
- name: Comment on pull request
5852
if: env.TYPOS != ''
@@ -61,7 +55,7 @@ jobs:
6155
github-token: ${{ secrets.GITHUB_TOKEN }}
6256
script: |
6357
const author = '${{github.event.pull_request.user.login}}';
64-
const typos = `${{ env.TYPOS }}`;
58+
const typos = process.env.TYPOS;
6559
const body = `
6660
Hi @${author},
6761
@@ -72,11 +66,11 @@ jobs:
7266
## ℹ️ Here's how to fix them:
7367
- **Fix typos:** Open the relevant files and fix any identified typos.
7468
- **Update wordlist:** If a flagged word is actually a project-specific term add it to \`wordlist.txt\` in the project root.
75-
Each word should be listed on a separate line. [Learn more.](http://aspell.net/man-html/Format-of-the-Personal-and-Replacement-Dictionaries.html)
69+
Each word should be listed on a separate line.
7670
- **🚧 Remember:**
7771
- When adding new words it MUST NOT have any spaces or special characters within or around it.
7872
- \`wordlist\` is NOT case sensitive.
79-
- Use backticks to quote code variables so as to not bloat the \`wordlist\`.
73+
- If code variables are flagged, wrap them in backticks instead of adding them to the \`wordlist\`. This way they are treated as code and won’t bloat the \`wordlist\` with project-specific identifiers.
8074
`;
8175
8276
github.rest.issues.createComment({

.gitignore

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,9 @@ claude-code
2626

2727
# Node.js dependencies
2828
node_modules/
29-
package.json
30-
package-lock.json
3129

3230
# Claude Code configuration
3331
CLAUDE.md
32+
33+
# Build folder
34+
**/dist/

CODE_OF_CONDUCT.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,23 @@ and orientation.
1212
We pledge to act and interact in ways that contribute to an open, welcoming,
1313
diverse, inclusive, and healthy community.
1414

15+
## Alignment with the Security Alliance (SEAL) Code of Conduct
16+
17+
This initiative follows the [Security Alliance (SEAL) Code of Conduct](https://www.securityalliance.org/news/Code_of_conduct), which sets expectations for all members and contributors across the organization.
18+
19+
At SEAL, we commit to:
20+
21+
- **Be Accountable** – Take responsibility for commitments and actions.
22+
- **Act Ethically** – Never exploit skills or information for malicious advantage.
23+
- **Protect Sensitive Information** – Handle confidential data responsibly.
24+
- **Speak the Truth** – Be honest in communications, reporting, and attribution.
25+
- **Respect Others** – Treat colleagues, users, and competitors with respect.
26+
- **Stay Informed** – Continuously learn and share knowledge to protect others.
27+
28+
**How This Applies to Our Initiative:**
29+
30+
SEAL’s Code establishes the baseline expectations for all contributors. In this initiative, you are expected to meet SEAL’s standards ***and*** the additional guidelines outlined below.
31+
1532
## Our Standards
1633

1734
Examples of behavior that contributes to a positive environment for our

0 commit comments

Comments
 (0)