From dc81279f9d09abba199031fe225b2e7ee9b23573 Mon Sep 17 00:00:00 2001 From: Sam Gammon Date: Thu, 13 Mar 2025 18:15:19 -0700 Subject: [PATCH 01/11] chore: beta1 docs Signed-off-by: Sam Gammon --- Writerside/cfg/analytics_head.html | 12 +- Writerside/cfg/buildprofiles.xml | 14 +-- Writerside/e.tree | 155 ++++++++++------------- Writerside/images/mark-sq-gray.svg | 6 + Writerside/redirection-rules.xml | 32 +++++ Writerside/topics/101-Environment.md | 2 +- Writerside/topics/Architecture.md | 10 +- Writerside/topics/CLI-Reference.md | 46 +++++-- Writerside/topics/Compatibility.md | 2 +- Writerside/topics/GettingStarted.md | 4 +- Writerside/topics/Index.md | 77 ++++++++++-- Writerside/topics/Installation.md | 18 --- Writerside/topics/JavaScript.md | 46 +++++-- Writerside/topics/Language-Guides.topic | 27 ++-- Writerside/topics/Node-API.md | 62 ++++----- Writerside/topics/Pkl.md | 71 ++++++++++- Writerside/topics/Python.md | 14 --- Writerside/topics/Ruby.md | 13 +- Writerside/topics/TypeScript.md | 22 +--- Writerside/topics/WinterTC.md | 35 ++++++ Writerside/topics/node-assert.md | 2 +- Writerside/topics/node-child-process.md | 141 +++++++++++++++++++-- Writerside/topics/node-events.md | 14 +++ Writerside/topics/node-zlib.md | 159 ++++++++++++++++++++++++ Writerside/v.list | 3 +- Writerside/writerside.cfg | 2 +- 26 files changed, 716 insertions(+), 273 deletions(-) create mode 100644 Writerside/images/mark-sq-gray.svg create mode 100644 Writerside/topics/WinterTC.md create mode 100644 Writerside/topics/node-zlib.md diff --git a/Writerside/cfg/analytics_head.html b/Writerside/cfg/analytics_head.html index b1d4dd9..acb0fc2 100644 --- a/Writerside/cfg/analytics_head.html +++ b/Writerside/cfg/analytics_head.html @@ -2,4 +2,14 @@ new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); -})(window,document,'script','dataLayer','GTM-MJRGMMMX'); \ No newline at end of file +})(window,document,'script','dataLayer','GTM-MJRGMMMX'); + \ No newline at end of file diff --git a/Writerside/cfg/buildprofiles.xml b/Writerside/cfg/buildprofiles.xml index 121f220..9848109 100644 --- a/Writerside/cfg/buildprofiles.xml +++ b/Writerside/cfg/buildprofiles.xml @@ -14,21 +14,17 @@ purple mark-e-favicon-r2.svg - mark-e-gray.png + mark-sq-gray.svg analytics_head.html analytics_tail.html - - true - https://github.com/elide-dev/docs/edit/main/Writerside/topics/ - false false - https://help.elide.dev - https://help.elide.dev + https://github.com/elide-dev/elide/issues/new + https://github.com/elide-dev/elide/issues/new true @@ -55,7 +51,7 @@ true - + icons @@ -68,6 +64,8 @@ %product% on GitHub + + diff --git a/Writerside/e.tree b/Writerside/e.tree index 935bf93..11fa480 100644 --- a/Writerside/e.tree +++ b/Writerside/e.tree @@ -3,10 +3,8 @@ SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd"> - + name="Elide" + start-page="Index.md"> @@ -16,100 +14,74 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + diff --git a/Writerside/images/mark-sq-gray.svg b/Writerside/images/mark-sq-gray.svg new file mode 100644 index 0000000..b4d3ace --- /dev/null +++ b/Writerside/images/mark-sq-gray.svg @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/Writerside/redirection-rules.xml b/Writerside/redirection-rules.xml index 0c49c66..d8f6ff3 100644 --- a/Writerside/redirection-rules.xml +++ b/Writerside/redirection-rules.xml @@ -5,4 +5,36 @@ Created after removal of "Welcome" from Elide Welcome.html + + Created after removal of "Code Samples" from Elide + Framework-Samples.html + + + Created after removal of "Elide Base" from Elide + Elide-Base.html + + + Created after removal of "Elide Core" from Elide + Elide-Core.html + + + Created after removal of "Elide Framework" from Elide + Elide-Framework.html + + + Created after removal of "Execution" from Elide + Execution.html + + + Created after removal of "Security" from Elide + Security.html + + + Created after removal of "Performance" from Elide + Performance.html + + + Created after removal of "Architecture" from Elide + Architecture.html + \ No newline at end of file diff --git a/Writerside/topics/101-Environment.md b/Writerside/topics/101-Environment.md index 32c4088..43e4921 100644 --- a/Writerside/topics/101-Environment.md +++ b/Writerside/topics/101-Environment.md @@ -18,7 +18,7 @@ uniform across all languages: in Elide. If you see a variable in JavaScript, you will see it as well in Python, Ruby, and so on. > With %product%, system environment variables are **invisible by default** to running code. You can allow access to -> system variables using [command line flags](CLI-Reference.md). +> environment using [command line flags](CLI-Reference.md). > {style="note"} ## Before you start diff --git a/Writerside/topics/Architecture.md b/Writerside/topics/Architecture.md index 236cccb..799f9c8 100644 --- a/Writerside/topics/Architecture.md +++ b/Writerside/topics/Architecture.md @@ -14,12 +14,4 @@ safety, and a full standard library with plenty of testing and functional covera -## Glossary - -A definition list or a glossary: - -First Term -: This is the definition of the first term. - -Second Term -: This is the definition of the second term. +> Note: This is already out of date, but it's as close as we have right now to an architectural diagram. diff --git a/Writerside/topics/CLI-Reference.md b/Writerside/topics/CLI-Reference.md index 11ebc35..a575315 100644 --- a/Writerside/topics/CLI-Reference.md +++ b/Writerside/topics/CLI-Reference.md @@ -7,16 +7,42 @@ Syntax: ```text -elide [OPTIONS] - or: elide info|help|discord|bug... [OPTIONS] - or: elide srcfile. [OPTIONS] - or: elide js|kt|jvm|python|ruby|wasm|node|deno [OPTIONS] [FILE] - or: elide run|repl|serve [OPTIONS] [FILE] - or: elide run|repl|serve [OPTIONS] [--code CODE] - or: elide run|repl [OPTIONS] - or: elide run|repl --js [OPTIONS] - or: elide run|repl --language=[JS] [OPTIONS] [FILE] - or: elide run|repl --languages=[JS,PYTHON,...] [OPTIONS] [FILE] + Usage: + or: elide info|help|discord|bug... [OPTIONS] + or: elide srcfile. [OPTIONS] + or: elide js|node|deno [OPTIONS] [FILE] [ARG...] + or: elide js|node|deno [OPTIONS] [--code CODE] + or: elide run|repl|serve [OPTIONS] [FILE] [ARG...] + or: elide run|repl|serve [OPTIONS] [--code CODE] + or: elide run|repl [OPTIONS] + or: elide run|repl --js [OPTIONS] + or: elide run|repl --language=[JS] [OPTIONS] [FILE] [ARG...] + or: elide run|repl --languages=[JS,PYTHON,...] [OPTIONS] [FILE] [ARG...] + +Manage, configure, and run polyglot applications with Elide + +Parameters: + [FILE] Source file to run. + [ARG...] Arguments to pass + +Options: + -h, --help Show this message and exit. + -V, --version Print version information and exit. + +Commands: + info Show info about the current app and environment + help, bug, issue + Report an issue or bug, find help for using Elide + run, r, serve, repl + Run a polyglot script, server, or interactive shell + pkl + Run the Pkl command-line tools + discord Open or show a Discord invite link + +Exit Codes: + 0 Successful program execution. + 1 Generic failure (terminal). + 2 Exception in user code. ``` ## Runner Commands diff --git a/Writerside/topics/Compatibility.md b/Writerside/topics/Compatibility.md index 7a2714a..1471f1f 100644 --- a/Writerside/topics/Compatibility.md +++ b/Writerside/topics/Compatibility.md @@ -11,7 +11,7 @@ Refer to the table below for resources regarding compatibility in each language. | Language | Stability | %product%'s Engine | Stock Engine | Notes | |--------------------------------|--------------------------------------------------------------------|-------------------------------------------------------------------------|------------------------------------------------|-----------------------------------------------------------------------------------------------------------------| -| [JavaScript](JavaScript.md) | ![Beta](https://img.shields.io/badge/-beta-purple) | [GraalJs](https://github.com/oracle/graaljs) | [V8](https://v8.dev/) | ECMA2023-compatible. [Node API](Node-API.md) compat pending. | +| [JavaScript](JavaScript.md) | ![Beta](https://img.shields.io/badge/-beta-purple) | [GraalJs](https://github.com/oracle/graaljs) | [V8](https://v8.dev/) | ECMA2024-compatible. [Node API](Node-API.md) compat pending. | | [WebAssembly](Experimental.md) | ![Alpha](https://img.shields.io/badge/-alpha-blue) | [GraalWasm](https://github.com/oracle/graal/blob/master/wasm/README.md) | [V8](https://v8.dev/) | | | [Python](Python.md) | ![Alpha](https://img.shields.io/badge/-alpha-blue) | [GraalPython](https://github.com/oracle/graalpython) | [CPython](https://github.com/python/cpython) | Roughly **~48% compatible** with PyPI top 500. See [here](https://www.graalvm.org/python/compatibility/). | | [Ruby](Ruby.md) | ![Alpha](https://img.shields.io/badge/-alpha-blue) | [TruffleRuby](https://github.com/oracle/truffleruby) | [MRI](https://rvm.io/interpreters/ruby) | Passes ~**97% of `ruby/spec`**. See [here](https://www.graalvm.org/latest/reference-manual/ruby/Compatibility/) | diff --git a/Writerside/topics/GettingStarted.md b/Writerside/topics/GettingStarted.md index 43de58c..4c2590c 100644 --- a/Writerside/topics/GettingStarted.md +++ b/Writerside/topics/GettingStarted.md @@ -10,8 +10,7 @@ You'll need an installed copy of %product%. Follow the [Installation](Installati ## Running some code %product% can accept a raw string of code or a file to run in any supported language. Best attempts are made to detect -the [primary language](Execution.md#primary-language) via the source file's extension (`.js` will load a JS VM, `.py` a -Python VM, etc.). +the primary language via the source file's extension (`.js` will load a JS VM, `.py` a Python VM, etc.). 1. Let's run a snippet of [JavaScript](JavaScript.md) @@ -81,6 +80,5 @@ elide ruby Installing %product% Polyglot 101: Thinking in Multiple Languages %product% Runtime: Language Guides - %product% Framework: Using %product% from JVM diff --git a/Writerside/topics/Index.md b/Writerside/topics/Index.md index 81454a8..c5f860d 100644 --- a/Writerside/topics/Index.md +++ b/Writerside/topics/Index.md @@ -1,29 +1,84 @@ -# Welcome +# README %product% -Welcome to the main [Elide](https://elide.dev) documentation site. Here you can find reference docs, -[guides](Polyglot.md), [code samples](Framework-Samples.md), and more. +[%product%](https://elide.dev) is a high-performance multi-language software runtime. Here you can find reference docs, guides, +code samples, and more.
-## %product% is in alpha +🚀 **%product% is a runtime, like Node or Python.** -Check out our alpha event launch video, which comes with sample code and demonstrates what %product% can do for your -workflow +You install it on your machine as a standalone binary. %product% is +statically linked and has essentially zero runtime dependencies. -