You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: sites/wonderland/README.md
+19-8Lines changed: 19 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,11 +21,13 @@ This repository contains the Wonderland Handbook, a documentation site built wit
21
21
From the monorepo root:
22
22
23
23
1. Install dependencies:
24
+
24
25
```bash
25
26
pnpm install
26
27
```
27
28
28
29
2. Build assets and start the development server:
30
+
29
31
```bash
30
32
pnpm --filter wonderland-handbook build:assets
31
33
pnpm --filter wonderland-handbook start
@@ -50,56 +52,65 @@ The handbook is automatically deployed to Vercel when changes are pushed to the
50
52
## Contributing
51
53
52
54
### To the handbook:
55
+
53
56
1. Create a new branch for your changes
54
57
2. Make your changes in the `docs/` directory
55
58
3. If you add new folders or files, you must also update `sidebars.ts`:
56
-
- This file defines the sidebar navigation using [Docusaurus sidebar configuration](https://docusaurus.io/docs/sidebar).
57
-
- Add your new documents to the appropriate category, or create a new one as needed.
59
+
60
+
- This file defines the sidebar navigation using [Docusaurus sidebar configuration](https://docusaurus.io/docs/sidebar).
61
+
- Add your new documents to the appropriate category, or create a new one as needed.
62
+
58
63
4. Test locally using `pnpm --filter wonderland-handbook start`
59
64
5. Submit a pull request
60
65
61
-
If you have any ideas for improving the handbook, feel free to open an issue (check the templates!) to start a discussion!
66
+
If you have any ideas for improving the handbook, feel free to open an issue (check the templates!) to start a discussion!
62
67
63
68
### To the blog:
64
69
65
70
Add a new Markdown/MDX file under `sites/wonderland/blog/`.
66
71
67
72
- Frontmatter (at the top of the file):
73
+
68
74
```md
69
75
---
70
76
title: Your post title
71
77
description: One-sentence summary shown in previews
72
78
authors:
73
-
- key: lumi # must exist in `blog/authors.yml`
74
-
date: 2024-11-06 # ISO date; time optional
75
-
image: /img/blog/slug/cover.png # social/OG image
76
-
tags: [topic1, topic2]# optional
79
+
- key: lumi # must exist in `blog/authors.yml`
80
+
date: 2024-11-06 # ISO date; time optional
81
+
image: /img/blog/slug/cover.png # social/OG image
82
+
tags: [topic1, topic2] # optional
77
83
---
78
84
```
85
+
79
86
- For multiple authors, use an array of `{ key }` objects. Example: `[{ key: lumi }, { key: shishigami }]`.
80
87
- Author profiles live in `sites/wonderland/blog/authors.yml` (keys must match).
81
88
82
89
- Images:
90
+
83
91
- Put post-specific images under `sites/wonderland/static/img/blog-posts-img/<slug>/`.
84
92
- Reference them with absolute paths: `/img/blog-posts-img/<slug>/image.png`.
85
93
- Recommended: a `cover.png` (1200×630) for social sharing via the `image` frontmatter.
86
94
87
95
- Naming:
96
+
88
97
- Prefer date-prefixed filenames to keep chronology: `YYYY-MM-DD-<slug>.md(x)`.
89
98
- The `<slug>` will become your URL segment. Keep it short, lowercase, and hyphenated.
90
99
91
100
- Content tips:
101
+
92
102
- Use standard Markdown. Code blocks get Prism syntax highlighting (e.g. solidity, ts).
93
103
- Headings create the right-hand table of contents automatically.
94
104
- For math, LaTeX is supported via remark-math/rehype-katex.
95
105
96
106
- Local preview:
107
+
97
108
```bash
98
109
pnpm --filter wonderland-handbook start
99
110
```
100
111
101
112
- PR checklist:
102
-
- 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).
113
+
- 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/Wonderland/status/1958612299859841473) and [here](https://x.com/Wonderland/status/1958249234429575375).
103
114
- Frontmatter present and valid.
104
115
- Images placed in `static/img/blog-posts-img/<slug>/` and referenced with `/img/blog-posts-img/<slug>/...`.
During our ["retreat,"](https://twitter.com/DeFi_Wonderland/status/1724121953512947965) on a night filled with wine, chess games, frisbee, and laughter, the break naturally turned into a work session. Working groups, motivated by enthusiasm (and a bit of alcohol), grouped to tackle some pending tasks. The HAI team was focused on the **last finding** of the 46 points raised in the two auditing processes.
15
+
During our ["retreat,"](https://twitter.com/Wonderland/status/1724121953512947965) on a night filled with wine, chess games, frisbee, and laughter, the break naturally turned into a work session. Working groups, motivated by enthusiasm (and a bit of alcohol), grouped to tackle some pending tasks. The HAI team was focused on the **last finding** of the 46 points raised in the two auditing processes.
16
16
17
17
The finding named “**Liquidation DOS**” was categorized as **"minor severity"** in one of the two audit reports, in our opinion, due to the following:
18
18
@@ -45,6 +45,7 @@ A week later, the [innocent proposal](https://www.tally.xyz/gov/reflexer-ungover
45
45
This is the story of how Wonderland endangered and rescued two protocols with a combined TVL of over \$25 million from a 500+ days old bug.
@@ -292,4 +293,4 @@ We have partnered with some of the most successful and promising protocols in We
292
293
293
294
We champion public good creation and believe in the invincibility of protocols backed by the right talent and incentives. We deeply believe in fostering a supportive community where collaboration trumps competition and building together is the norm, not the exception.
294
295
295
-
**DeFi sucks, but we are here to make it better.**
296
+
**DeFi sucks, but we are here to make it better.**
0 commit comments