jade-docs/faq.html at main · Fundiman/jade-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>frequently asked questions — jade-docs</title>
<link rel="preconnect" href="https://fonts.googleapis.com">
<link href="https://fonts.googleapis.com/css2?family=DM+Mono:ital,wght@0,300;0,400;0,500;1,400&family=Fraunces:ital,opsz,wght@0,9..144,300;0,9..144,600;1,9..144,300&family=DM+Sans:wght@300;400;500&display=swap" rel="stylesheet">
<style>
  *, *::before, *::after { box-sizing: border-box; margin: 0; padding: 0; }
  :root {
    --jade:     #1D9E75;
    --jade-dim: #0F6E56;
    --jade-bg:  #E1F5EE;
    --ink:      #0e1a14;
    --ink-dim:  #3a5245;
    --ink-mute: #7a9e8e;
    --paper:    #f7faf8;
    --card:     #ffffff;
    --border:   #d4e8de;
    --mono:     'DM Mono', monospace;
    --serif:    'Fraunces', serif;
    --sans:     'DM Sans', sans-serif;
  }
  html { scroll-behavior: smooth; }
  body { font-family: var(--sans); background: var(--paper); color: var(--ink); min-height: 100vh; }

  header {
    border-bottom: 1px solid var(--border);
    padding: 0 2rem;
    display: flex;
    align-items: center;
    justify-content: space-between;
    height: 56px;
    background: var(--card);
    position: sticky;
    top: 0;
    z-index: 100;
  }
  .logo { display: flex; align-items: center; gap: 10px; text-decoration: none; }
  .logo-name { font-family: var(--serif); font-weight: 600; font-size: 1.2rem; color: var(--jade-dim); letter-spacing: -0.02em; }
  .logo-version { font-family: var(--mono); font-size: 0.68rem; color: var(--ink-mute); background: var(--jade-bg); padding: 2px 7px; border-radius: 20px; border: 1px solid var(--border); }
  nav a { font-size: 0.85rem; color: var(--ink-dim); text-decoration: none; margin-left: 1.5rem; transition: color .15s; }
  nav a:hover { color: var(--jade); }

  main {
    max-width: 780px;
    margin: 0 auto;
    padding: 3rem 2rem 5rem;
  }

  h1 { font-family: var(--serif); font-size: 2.2rem; font-weight: 300; color: var(--ink); margin: 0 0 1.5rem; letter-spacing: -0.02em; line-height: 1.2; }
  h2 { font-family: var(--serif); font-size: 1.4rem; font-weight: 300; color: var(--ink); margin: 2.5rem 0 1rem; padding-bottom: 0.4rem; border-bottom: 1px solid var(--border); }
  h3 { font-size: 1rem; font-weight: 500; color: var(--ink); margin: 1.8rem 0 0.6rem; }
  h4 { font-size: 0.9rem; font-weight: 500; color: var(--ink-dim); margin: 1.2rem 0 0.4rem; }
  h5, h6 { font-size: 0.85rem; font-weight: 500; color: var(--ink-mute); margin: 1rem 0 0.3rem; }

  p { font-size: 0.95rem; line-height: 1.75; color: var(--ink-dim); margin: 0 0 1rem; }
  a { color: var(--jade-dim); text-decoration: none; }
  a:hover { text-decoration: underline; }
  strong { font-weight: 500; color: var(--ink); }
  em { font-style: italic; }

  code {
    font-family: var(--mono);
    font-size: 0.82em;
    background: var(--jade-bg);
    color: var(--jade-dim);
    padding: 2px 6px;
    border-radius: 4px;
    border: 1px solid var(--border);
  }

  pre {
    background: var(--ink);
    border-radius: 10px;
    padding: 1.2rem 1.4rem;
    margin: 1rem 0 1.5rem;
    overflow-x: auto;
    border: 1px solid #1a2e25;
  }
  pre code {
    font-family: var(--mono);
    font-size: 0.82rem;
    line-height: 1.65;
    background: none;
    color: #a8e6cf;
    padding: 0;
    border: none;
    border-radius: 0;
  }

  ul, ol { padding-left: 1.4rem; margin: 0 0 1rem; }
  li { font-size: 0.95rem; line-height: 1.75; color: var(--ink-dim); margin-bottom: 0.2rem; }
  li code { font-size: 0.8em; }

  blockquote {
    border-left: 3px solid var(--jade);
    padding: 0.6rem 1rem;
    margin: 1rem 0;
    background: var(--jade-bg);
    border-radius: 0 6px 6px 0;
  }
  blockquote p { margin: 0; color: var(--jade-dim); font-size: 0.9rem; }

  table {
    width: 100%;
    border-collapse: collapse;
    margin: 1rem 0 1.5rem;
    font-size: 0.88rem;
  }
  th {
    background: var(--jade-bg);
    color: var(--jade-dim);
    font-weight: 500;
    text-align: left;
    padding: 8px 12px;
    border: 1px solid var(--border);
  }
  td {
    padding: 8px 12px;
    border: 1px solid var(--border);
    color: var(--ink-dim);
    line-height: 1.5;
  }
  tr:nth-child(even) td { background: var(--paper); }

  hr {
    border: none;
    border-top: 1px solid var(--border);
    margin: 2rem 0;
  }

  footer {
    border-top: 1px solid var(--border);
    padding: 1.5rem 2rem;
    display: flex;
    align-items: center;
    justify-content: space-between;
    flex-wrap: wrap;
    gap: 1rem;
    background: var(--card);
  }
  footer p { font-size: 0.78rem; color: var(--ink-mute); font-family: var(--mono); }
  footer a { color: var(--jade-dim); text-decoration: none; }
  footer a:hover { text-decoration: underline; }

  @media (max-width: 600px) {
    nav { display: none; }
    main { padding: 2rem 1rem 4rem; }
    h1 { font-size: 1.6rem; }
  }
</style>
</head>
<body>

<header>
  <a href="index.html" class="logo">
    <svg width="28" height="28" viewBox="0 0 100 100">
      <polygon points="50,5 85,25 85,75 50,95 15,75 15,25" fill="#E1F5EE" stroke="#1D9E75" stroke-width="3"/>
      <polygon points="50,20 72,33 72,67 50,80 28,67 28,33" fill="#1D9E75" opacity="0.3"/>
      <polygon points="50,32 64,40 64,60 50,68 36,60 36,40" fill="#1D9E75" opacity="0.65"/>
      <circle cx="50" cy="50" r="6" fill="#0F6E56"/>
    </svg>
    <span class="logo-name">jade-docs</span>
    <span class="logo-version">v0.1.0-alpha</span>
  </a>
  <nav>
    <a href="guide/01-getting-started.html">guides</a>
    <a href="stdlib/io.html">stdlib</a>
    <a href="reference/syntax.html">reference</a>
    <a href="https://github.com/Fundiman/JadeLang">github</a>
  </nav>
</header>

<main>
<h1>frequently asked questions</h1>

<hr>

<h2>about the language</h2>

<h3>why does Jade exist?</h3>

<p>because "write once, run anywhere" has been a lie for 30 years.</p>

<p>Java promised it. Then you spent half your time debugging things that worked on your machine but not production. Python is slow and has the GIL. Kotlin only really works on JVM or Android. JavaScript somehow ended up everywhere but nobody planned that.</p>

<p>Jade is an attempt to do it properly — a language that compiles to a fat binary containing both native code AND LLVM bitcode, so it literally runs everywhere either natively or via JIT. no runtime to install. no "works on my machine."</p>

<h3>why the name Jade?</h3>

<p>it's a gemstone. it's green. it sounds good.</p>

<p>also pug is a templating engine for JavaScript and we are absolutely not affiliated with it in any way and pug has no reason to be concerned about us whatsoever. 🫡</p>

<h3>why Ruby + Go + Kotlin?</h3>

<ul><li><strong>Ruby</strong> — because code should be a joy to read and write</li><li><strong>Go</strong> — because simplicity and fast compilation matter</li><li><strong>Kotlin</strong> — because type safety and modern features matter</li></ul>

<p>none of them alone is perfect. Jade tries to take the best parts of each.</p>

<h3>why curly braces and semicolons?</h3>

<p>curly braces because they're unambiguous. indentation-sensitive languages are elegant until you're debugging a whitespace issue at 2AM.</p>

<p>semicolons because they teach structure. every statement has a clear end. no ambiguity about whether a newline ends an expression.</p>

<h3>why no exceptions?</h3>

<p>exceptions are invisible control flow. a function that throws can fail in ways that aren't visible in its signature. you have to read the docs (or the source) to know what might blow up.</p>

<p><code>Result&lt;T&gt;</code> makes errors explicit. if a function can fail, its return type says so. the compiler makes you handle it. no surprises.</p>

<hr>

<h2>about the compiler</h2>

<h3>what is a .joc file?</h3>

<p>Jade Object Code — a fat binary containing:</p>
<ul><li>native machine code for specific architectures (x86_64, ARM64, etc)</li><li>LLVM bitcode as a portable fallback</li></ul>

<p><code>jvk</code> reads the <code>.joc</code>, picks the native slice if one matches the current CPU, and JIT-compiles the LLBC slice otherwise. one file, runs everywhere.</p>

<h3>why LLVM?</h3>

<p>LLVM is the best compiler backend in existence. it handles register allocation, instruction selection, and optimization better than anything you'd write yourself. Rust, Swift, Clang, Julia, Zig — they all use LLVM. so does Jade.</p>

<h3>why is jscc written in C++?</h3>

<p>because LLVM is a C++ library. calling it from C++ is the path of least resistance. also C++ is fast and the compiler needs to be fast.</p>

<h3>can jscc compile itself?</h3>

<p>not yet. once the language is complete enough, bootstrapping is on the roadmap. a compiler that can compile itself is a rite of passage.</p>

<hr>

<h2>about the runtime</h2>

<h3>what is jvk?</h3>

<p>the Jade Virtual Kernel. it's the process that loads and runs <code>.joc</code> files. it provides:</p>
<ul><li>a HAL (host abstraction layer) for Linux, macOS, and Windows</li><li>a virtual filesystem</li><li>a scheduler</li><li>memory management</li><li>the JIT engine for LLBC slices</li></ul>

<h3>why a "kernel"?</h3>

<p>because programs compiled for Jade don't talk to the OS directly — they talk to <code>jvk</code>, which then talks to the OS through the HAL. this is how "write once run anywhere" actually works — the inconsistencies are hidden inside <code>jvk</code>, not exposed to your code.</p>

<h3>is jvk a real kernel?</h3>

<p>it's a userspace kernel — it runs as a normal process on top of your OS. it doesn't replace the OS kernel. think of it like the JVM but for Jade.</p>

<hr>

<h2>about the ecosystem</h2>

<h3>what is jade-pkgs?</h3>

<p>the official Jade package registry. it's a GitHub repo at <a href="https://github.com/Fundiman/jade-pkgs">Fundiman/jade-pkgs</a>. packages are published by opening pull requests — no separate account needed, just a GitHub account.</p>

<h3>why a git-based registry?</h3>

<p>because it's free, auditable, requires no servers, and is already backed up everywhere GitHub is backed up. it's how Homebrew works and Homebrew serves millions of packages just fine.</p>

<h3>what is jpkg?</h3>

<p>the Jade package manager. written in Python so it runs everywhere Python runs (which is everywhere). handles dependencies, builds, and publishing.</p>

<hr>

<h2>about the license</h2>

<h3>why LGPL for the language?</h3>

<p>LGPL means:</p>
<ul><li>you can write closed-source apps IN Jade — your app code is yours</li><li>if you modify Jade itself (the compiler, stdlib, kernel), those changes must be shared back</li></ul>

<p>this is the right balance for a language — maximum freedom for users, protection against the language being forked and closed.</p>

<h3>why CC BY-NC-SA for the docs?</h3>

<p>because docs are content, not software. CC BY-NC-SA means:</p>
<ul><li>anyone can read, share, and build on the docs</li><li>no commercial use without permission</li><li>derivatives must use the same license</li></ul>

<p>translations, tutorials, and community guides are all allowed.</p>

<hr>

<h2>miscellaneous</h2>

<h3>how long did Jade take to build?</h3>

<p>the initial version — compiler, kernel, package manager, standard library, UI framework, and documentation — was built in a single day.</p>

<p>no that is not a typo.</p>

<h3>can I contribute?</h3>

<p>yes. see <a href="contributing.html">contributing.md</a>.</p>

<h3>where do I report bugs?</h3>

<p><a href="https://github.com/Fundiman/JadeLang/issues">github.com/Fundiman/JadeLang/issues</a></p>

<h3>will Jade ever reach 1.0.0?</h3>

<p>the roadmap to 1.0.0:</p>
<ul><li>LSP server / VS Code extension (syntax highlighting done ✅)</li><li><code>jade fmt</code> + <code>jade test</code></li><li>async runtime (suspend/resume)</li><li>reactive state for JadeUI</li><li>string interpolation wired into jscc codegen</li><li>JadeUI stable release</li></ul>

<p>it'll get there. 🫡</p>

</main>

<footer>
  <p>© 2026 <a href="https://github.com/Fundiman">Fundiman</a> — <a href="https://github.com/Fundiman/jade-docs">jade-docs</a> — <a href="https://creativecommons.org/licenses/by-nc-sa/4.0/">CC BY-NC-SA 4.0</a></p>
  <p><a href="https://github.com/Fundiman/JadeLang">JadeLang</a> · <a href="https://github.com/Fundiman/jade-pkgs">jade-pkgs</a> · <a href="https://github.com/Fundiman/jade-docs">jade-docs</a></p>
</footer>

</body>
</html>