Skip to content

Commit 10780ba

Browse files
site: add new docs pages to llms.txt and sitemap
llms.txt and sitemap.xml were missing the pages added since: glob, process, path, http guides, plus migration, typescript, and errors. Add all seven, and note `esrun types --install` on the CLI line.
1 parent a626b02 commit 10780ba

2 files changed

Lines changed: 36 additions & 1 deletion

File tree

site/public/llms.txt

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,14 @@ ES-Runtime (`esrun`) runs standard ECMAScript modules with only the Web-platform
1212
- [Global objects](https://esrun.opentechf.org/docs/globals): the Web-standard globals available (fetch, URL, streams, WebCrypto, encoding, timers, events) and what is intentionally absent.
1313
- [Security model](https://esrun.opentechf.org/docs/security): how host I/O is mediated — capability checks enforced at the op boundary.
1414
- [Scope & non-goals](https://esrun.opentechf.org/docs/scope): a runtime, not a toolchain — explicitly no Node.js compatibility, CommonJS, TypeScript, JSX, bundler, package installer, test runner, FFI, or workers.
15+
- [Migration guide](https://esrun.opentechf.org/docs/migration): moving from Node.js, Bun, or Deno — equivalents for `process`/env, the filesystem, and the explicit `runtime:` import model (no ambient globals).
16+
- [TypeScript setup](https://esrun.opentechf.org/docs/typescript): editor types for the `runtime:*` modules via `esrun types --install` (writes the definitions into `node_modules` and wires `tsconfig.json`).
17+
- [Error diagnostics](https://esrun.opentechf.org/docs/errors): how uncaught exceptions and unhandled rejections are reported — stack traces, source positions, and the CLI error format.
1518

1619
## API reference
1720

1821
- [API overview](https://esrun.opentechf.org/api): the surface area — the `runtime:` standard modules and the CLI.
19-
- [esrun CLI](https://esrun.opentechf.org/api/cli): command-line usage — running a module, `-e` inline snippets, `--timeout`, `esrun types`, `esrun upgrade`.
22+
- [esrun CLI](https://esrun.opentechf.org/api/cli): command-line usage — running a module, `-e` inline snippets, `--timeout`, `esrun types` (and `types --install`), `esrun upgrade`.
2023
- [runtime:process](https://esrun.opentechf.org/api/process): `env`, `args`, `cwd()`, `platform`, `arch`, `exit()`.
2124
- [runtime:path](https://esrun.opentechf.org/api/path): platform-aware path utilities — `join`, `resolve`, `dirname`, `basename`, `parse`, and `file:` URL interop.
2225
- [runtime:fs](https://esrun.opentechf.org/api/fs): Blob-based async file I/O — `file()` handles, `write()`, `readDir`, `stat`, `mkdir`, `remove`, `rename`, and `Glob`; confined to a root jail. Gated on FileRead/FileWrite.
@@ -31,6 +34,10 @@ ES-Runtime (`esrun`) runs standard ECMAScript modules with only the Web-platform
3134
## Guides
3235

3336
- [File handling](https://esrun.opentechf.org/docs/guides/file-handling): reading, writing, streaming, and globbing files with `runtime:fs`.
37+
- [Glob matching](https://esrun.opentechf.org/docs/glob): match and scan paths with the `Glob` API — every supported pattern token (`*`, `**`, `?`, `[abc]`, `{a,b}`, `!`).
38+
- [Process & Env](https://esrun.opentechf.org/docs/process): reading environment variables, arguments, and the working directory via `runtime:process`.
39+
- [Path handling](https://esrun.opentechf.org/docs/path): building and parsing paths with `runtime:path` — `join`, `resolve`, `dirname`, `basename`, `extname`.
40+
- [HTTP server](https://esrun.opentechf.org/docs/http): serving requests with `runtime:http` `serve(options, handler)` and web `Request`/`Response`; frameworks like Hono work out of the box.
3441

3542
## Source
3643

site/public/sitemap.xml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,34 @@
4242
<loc>https://esrun.opentechf.org/docs/guides/file-handling</loc>
4343
<priority>0.6</priority>
4444
</url>
45+
<url>
46+
<loc>https://esrun.opentechf.org/docs/glob</loc>
47+
<priority>0.6</priority>
48+
</url>
49+
<url>
50+
<loc>https://esrun.opentechf.org/docs/process</loc>
51+
<priority>0.6</priority>
52+
</url>
53+
<url>
54+
<loc>https://esrun.opentechf.org/docs/path</loc>
55+
<priority>0.6</priority>
56+
</url>
57+
<url>
58+
<loc>https://esrun.opentechf.org/docs/http</loc>
59+
<priority>0.6</priority>
60+
</url>
61+
<url>
62+
<loc>https://esrun.opentechf.org/docs/migration</loc>
63+
<priority>0.6</priority>
64+
</url>
65+
<url>
66+
<loc>https://esrun.opentechf.org/docs/typescript</loc>
67+
<priority>0.6</priority>
68+
</url>
69+
<url>
70+
<loc>https://esrun.opentechf.org/docs/errors</loc>
71+
<priority>0.6</priority>
72+
</url>
4573
<url>
4674
<loc>https://esrun.opentechf.org/api</loc>
4775
<changefreq>weekly</changefreq>

0 commit comments

Comments
 (0)