fix: wire sync-contributing into build pipeline (closes #246)

CONTRIBUTING.md

@@ -4,8 +4,7 @@ This file is automatically synced from docs/pages/contribute/contributing.mdx du
 ⚠️ DO NOT EDIT THIS FILE DIRECTLY. 
 Instead, make changes to docs/pages/contribute/contributing.mdx and make this be synced just by running the build command.
 
-Both files contain the same content: the docs file is there to render the content on the website,
-while this copy is needed to make it highlighted in the repository dashboard.
+Both files contain the same content: the docs file is there to render the content on the website, while this copy is needed to make it highlighted in the repository dashboard.
 -->
 
 # **Contributing guidelines**
@@ -42,8 +41,8 @@ approved, they will be merged into the **main branch** for publication on the st
 
 ## Ways to contribute
 
-There are several ways to contribute, depending on your preference and the scope of your changes.
-First, check existing PRs or branches to make sure your work has not been previously submitted.
+There are several ways to contribute, depending on your preference and the scope of your changes. First, check existing
+PRs or branches to make sure your work has not been previously submitted.
 
 ### 1. Quick edits
 
@@ -360,8 +359,8 @@ pie title What Voldemort doesn't have?
 - Adding images is welcome and encouraged.
   Please follow the steps below to include them correctly:
 
-  1. After making your changes and opening a PR, add the images you want to include in the PR's comments
-  (by uploading them directly)
+  1. After making your changes and opening a PR, add the images you want to include
+     in the PR's comments (by uploading them directly)
   2. During the review, a maintainer will upload your images to our S3 bucket and reply with the links you should use.
   3. Once you receive the new links, update your PR to add the images' links.
 

justfile

@@ -6,8 +6,12 @@ default:
 install:
     pnpm install
 
+# Sync CONTRIBUTING.md from contributing.mdx
+sync:
+    node utils/sync-contributing.js
+
 # Serve the Vocs site locally with hot reload
-serve: 
+serve:
     pnpm run docs:dev
 
 # Build the static Vocs site

package.json

@@ -12,8 +12,9 @@
   },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "docs:dev": "pnpm run generate-tags && pnpm run generate-indexes && pnpm run mermaid-wrapper && vocs dev --host 0.0.0.0 --port 5173",
-    "docs:build": "pnpm run generate-tags && pnpm run generate-indexes && pnpm run mermaid-wrapper && pnpm run generate-printables && pnpm run generate-cert-data && vocs build",
+    "sync-contributing": "node utils/sync-contributing.js",
+    "docs:dev": "pnpm run sync-contributing && pnpm run generate-tags && pnpm run generate-indexes && pnpm run mermaid-wrapper && vocs dev --host 0.0.0.0 --port 5173",
+    "docs:build": "pnpm run sync-contributing && pnpm run generate-tags && pnpm run generate-indexes && pnpm run mermaid-wrapper && pnpm run generate-printables && pnpm run generate-cert-data && vocs build",
     "postdocs:build": "node utils/searchbar-indexing.js && node utils/sitemap-generator.js",
     "docs:preview": "vocs preview",
     "generate-tags": "node utils/tags-fetcher.js",

wordlist.txt

@@ -362,3 +362,6 @@ viem
 wagmi
 NCSC
 Intune
+AADAPT
+SCWE
+EthTrust