feat: ideal deployments saga

.github/workflows/test-scripts.yml

@@ -28,6 +28,10 @@ jobs:
       - name: Install dependencies
         run: pnpm install --frozen-lockfile
 
-      - name: Run tests
+      - name: Run scripts tests
         working-directory: scripts
+        run: pnpm test
+
+      - name: Run wonderland tests
+        working-directory: sites/wonderland
         run: pnpm test 

README.md

@@ -28,7 +28,7 @@ From the root of the monorepo:
 ```bash
 pnpm install                                   # Install all dependencies across packages/sites
 pnpm --filter [name]-handbook build:assets     # Build common files, and copy them into the specific site
-pnpm --filter [name]-handbook start              # Start the site locally
+pnpm --filter [name]-handbook start            # Start the site locally
 ```
 
 **Example with the Wonderland handbook:**
@@ -65,16 +65,19 @@ pnpm create-handbook <site-name>
 ```
 
 This will:
+
 1. Create a new site in `sites/<site-name>` based on the template
 2. Update the package.json with the correct site name
 3. Set up all necessary configurations
 
 **Example:**
+
 ```bash
 pnpm create-handbook my-new-handbook
 ```
 
 After creation, you can build and start the new site:
+
 ```bash
 cd sites/my-new-handbook
 pnpm build:assets

scripts/package.json

@@ -8,10 +8,15 @@
     "test:coverage": "jest --coverage",
     "copy-static": "ts-node src/copyStaticTo.ts"
   },
+  "dependencies": {
+    "js-yaml": "4.1.0",
+    "zod": "3.23.8"
+  },
   "devDependencies": {
     "@jest/globals": "29.7.0",
     "@types/jest": "29.5.12",
     "@types/node": "24.0.3",
+    "@types/js-yaml": "4.0.9",
     "jest": "29.7.0",
     "jest-environment-node": "29.7.0",
     "ts-jest": "29.1.2",

scripts/src/copyStaticTo.ts

@@ -36,4 +36,4 @@ try {
 } catch (error) {
   console.error(`❌ Failed to copy static assets: ${error}`);
   process.exit(1);
-}
+}

sites/wonderland/.gitignore

@@ -1,2 +1,3 @@
 # Static assets
-/static/common/
+/static/common/
+blog/authors.yml

sites/wonderland/README.md

@@ -49,6 +49,7 @@ The handbook is automatically deployed to Vercel when changes are pushed to the
 
 ## Contributing
 
+### To the handbook:
 1. Create a new branch for your changes
 2. Make your changes in the `docs/` directory
 3. If you add new folders or files, you must also update `sidebars.ts`:
@@ -57,4 +58,49 @@ The handbook is automatically deployed to Vercel when changes are pushed to the
 4. Test locally using `pnpm --filter wonderland-handbook start`
 5. Submit a pull request
 
-If you have any ideas for improving the handbook, feel free to open an issue (check the templates!) to start a discussion! 
+If you have any ideas for improving the handbook, feel free to open an issue (check the templates!) to start a discussion! 
+
+### To the blog:
+
+Add a new Markdown/MDX file under `sites/wonderland/blog/`.
+
+- Frontmatter (at the top of the file):
+  ```md
+  ---
+  title: Your post title
+  description: One-sentence summary shown in previews
+  authors:
+    - key: lumi            # must exist in `blog/authors.yml`
+  date: 2024-11-06         # ISO date; time optional
+  image: /img/blog/slug/cover.png   # social/OG image
+  tags: [topic1, topic2]   # optional
+  ---
+  ```
+  - For multiple authors, use an array of `{ key }` objects. Example: `[{ key: lumi }, { key: shishigami }]`.
+  - Author profiles live in `sites/wonderland/blog/authors.yml` (keys must match).
+
+- Images:
+  - Put post-specific images under `sites/wonderland/static/img/blog-posts-img/<slug>/`.
+  - Reference them with absolute paths: `/img/blog-posts-img/<slug>/image.png`.
+  - Recommended: a `cover.png` (1200×630) for social sharing via the `image` frontmatter.
+
+- Naming:
+  - Prefer date-prefixed filenames to keep chronology: `YYYY-MM-DD-<slug>.md(x)`.
+  - The `<slug>` will become your URL segment. Keep it short, lowercase, and hyphenated.
+
+- Content tips:
+  - Use standard Markdown. Code blocks get Prism syntax highlighting (e.g. solidity, ts).
+  - Headings create the right-hand table of contents automatically.
+  - For math, LaTeX is supported via remark-math/rehype-katex.
+
+- Local preview:
+  ```bash
+  pnpm --filter wonderland-handbook start
+  ```
+
+- PR checklist:
+  - Nice to have: in your PR description, add a small thread about your article to share on Wonderland's twitter 🤍 Remember to include a small description about yourself. Reference [here](https://x.com/DeFi_Wonderland/status/1958612299859841473) and [here](https://x.com/DeFi_Wonderland/status/1958249234429575375).
+  - Frontmatter present and valid.
+  - Images placed in `static/img/blog-posts-img/<slug>/` and referenced with `/img/blog-posts-img/<slug>/...`.
+  - Links work and code blocks render.
+  - Authors exist in `blog/authors.yml` (or add them there).