Skip to content

Commit

Permalink
docs: much doc work, many page
Browse files Browse the repository at this point in the history
  • Loading branch information
sgammon committed May 14, 2024
1 parent bf1694e commit 27da4f7
Show file tree
Hide file tree
Showing 49 changed files with 23,649 additions and 327 deletions.
6 changes: 6 additions & 0 deletions .idea/icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Creative/images/architecture/arch-v1-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5,566 changes: 5,566 additions & 0 deletions Creative/images/architecture/arch-v1-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5,831 changes: 5,831 additions & 0 deletions Creative/images/architecture/arch-v1-grid-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Creative/images/architecture/arch-v1-grid.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5,831 changes: 5,831 additions & 0 deletions Creative/images/architecture/arch-v1-grid.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Creative/images/architecture/arch-v1-tx-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Creative/images/architecture/arch-v1-tx.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Creative/images/architecture/arch-v1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5,566 changes: 5,566 additions & 0 deletions Creative/images/architecture/arch-v1.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions Writerside/c.list
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@
<category id="tutorialSeries" name="Continue this series" order="1" />
<category id="referenceDocs" name="Reference documentation" order="2"/>
<category id="wrs" name="Writerside documentation" order="3"/>
<category id="gettingStarted" name="Getting Started with %product%" order="4" />
</categories>
11 changes: 11 additions & 0 deletions Writerside/cfg/buildprofiles.xml
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,15 @@
<noindex-content>false</noindex-content>
</variables>
</build-profile>

<icons>
<shared-src>icons</shared-src>
</icons>

<footer>
<social type="linkedin" href="https://www.linkedin.com/company/elidecloud">%product% on LinkedIn</social>
<social type="twitter" href="https://twitter.com/elide_dev">%product% on Twitter</social>
<link href="https://elide.dev">Website</link>
<link href="https://github.com/elide-dev">%product% on GitHub</link>
</footer>
</buildprofiles>
6 changes: 6 additions & 0 deletions Writerside/cfg/glossary.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE terms SYSTEM "https://resources.jetbrains.com/writerside/1.0/glossary.dtd">
<terms>
<term name="GUI">Graphical User Interface</term>
<term name="HTTP">Hypertext Transfer Protocol</term>
</terms>
8 changes: 7 additions & 1 deletion Writerside/e.tree
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
<toc-element toc-title="TLS/SSL" />
<toc-element toc-title="TTY" />
<toc-element toc-title="UDP/Datagram" />
<toc-element toc-title="URL" />
<toc-element topic="node-url.md"/>
<toc-element toc-title="Utilities" />
<toc-element toc-title="V8" />
<toc-element toc-title="VM" />
Expand Down Expand Up @@ -82,6 +82,7 @@
<toc-element topic="Architecture.md">
<toc-element topic="Execution.md"/>
<toc-element topic="Security.md"/>
<toc-element topic="Performance.md"/>
<toc-element toc-title="Embedded Engines">
<toc-element toc-title="GraalJs" href="https://github.com/oracle/graaljs" />
<toc-element toc-title="GraalWasm" href="https://github.com/oracle/graal/blob/master/wasm/README.md" />
Expand All @@ -96,6 +97,11 @@
<toc-element toc-title="Kotlin" href="https://kotlin-lang.org" />
</toc-element>
</toc-element>
<toc-element toc-title="Release Notes">
<toc-element toc-title="1.0.0-alpha9" href="https://github.com/elide-dev/elide/releases/tag/1.0.0-alpha9" />
<toc-element toc-title="1.0.0-alpha8" href="https://github.com/elide-dev/elide/releases/tag/1.0.0-alpha8" />
<toc-element toc-title="1.0.0-alpha7" href="https://github.com/elide-dev/elide/releases/tag/1.0.0-alpha7" />
</toc-element>
<toc-element toc-title="Legal &amp; Licensing">
<toc-element toc-title="Terms of Use" />
<toc-element toc-title="Privacy Policy" />
Expand Down
Binary file added Writerside/images/arch-v1-grid.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions Writerside/images/arch-v1-grid.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Writerside/images/arch-v1-grid_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions Writerside/images/arch-v1-grid_dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Writerside/images/arch-v1-tx.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Writerside/images/arch-v1-tx_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Writerside/images/arch-v1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions Writerside/images/arch-v1.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Writerside/images/arch-v1_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions Writerside/images/arch-v1_dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Writerside/images/bin-help.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Writerside/images/bin-selftest.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Writerside/images/completion_procedure.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Writerside/images/completion_procedure_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Writerside/images/convert_table_to_xml.png
Binary file modified Writerside/images/convert_table_to_xml_dark.png
75 changes: 1 addition & 74 deletions Writerside/images/mark-e-favicon-r2.svg
Binary file modified Writerside/images/mark-e-gray.png
50 changes: 1 addition & 49 deletions Writerside/images/mark-e.svg
Binary file modified Writerside/images/new_topic_options.png
Binary file modified Writerside/images/new_topic_options_dark.png
41 changes: 0 additions & 41 deletions Writerside/redirection-rules.xml
Original file line number Diff line number Diff line change
@@ -1,45 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE rules SYSTEM "https://resources.jetbrains.com/writerside/1.0/redirection-rules.dtd">
<rules>
<!-- format is as follows
<rule id="<unique id>">
<accepts>page.html</accepts>
</rule>
-->
<rule id="34671e9e">
<description>Created after removal of "Server Starter" from Elide</description>
<accepts>Server-Starter.html</accepts>
</rule>
<rule id="65b69b0">
<description>Created after removal of "Language Guides" from Elide</description>
<accepts>Section-Starting-Page.html</accepts>
</rule>
<rule id="18f4cf26">
<description>Created after removal of "Guides by Engine" from Elide</description>
<accepts>Guides-by-Language.html</accepts>
</rule>
<rule id="5c5f41e5">
<description>Created after removal of "Code Samples" from Elide</description>
<accepts>Samples.html</accepts>
</rule>
<rule id="8373fb4">
<description>Created after removal of "Reference" from Elide</description>
<accepts>Reference.html</accepts>
</rule>
<rule id="1e57e77d">
<description>Created after removal of "Reference" from Elide</description>
<accepts>Reference.html</accepts>
</rule>
<rule id="5b129b60">
<description>Created after removal of "Starter" from Elide</description>
<accepts>starter.html</accepts>
</rule>
<rule id="28913f73">
<description>Created after removal of "Template" from Elide</description>
<accepts>node-template.html</accepts>
</rule>
<rule id="41ba8e48">
<description>Created after removal of "Debugger" from Elide</description>
<accepts>node-debugger.html</accepts>
</rule>
</rules>
15 changes: 11 additions & 4 deletions Writerside/topics/Architecture.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,18 @@
# Architecture

Overview articles give background information and provide context to a particular subject.
Their goal is to explain a concept, not to teach or give instructions.
This page gives an overview of %product%'s internal architecture. Users of %product% don't necessarily need to know
these details; these docs are mostly for contributors, but everyone is welcome!

## What is product/service/concept
## How %product% works

Provide some background and context, explain choices and alternatives.
At a high level, %product% is a suite of libraries and applications written for the Java Virtual Machine, or
[JVM](https://docs.oracle.com/en/java/javase/21/vm/java-virtual-machine-technology-overview.html).

The JVM is an incredibly powerful runtime system, offering state-of-the-art just-in-time (JIT) compilation, memory
safety, and a full standard library with plenty of testing and functional coverage (referred to as the
[JDK](https://en.wikipedia.org/wiki/Java_Development_Kit), for Java Development Kit).

<img src="arch-v1.svg" />

## Glossary

Expand Down
9 changes: 9 additions & 0 deletions Writerside/topics/GettingStarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,3 +75,12 @@ elide ruby
> You can use <shortcut>Ctrl+D</shortcut> or <shortcut>Ctrl+C</shortcut> twice to exit the interactive session.
>
{style="note"}

<seealso>
<category ref="gettingStarted">
<a href="Installation.md">Installing %product%</a>
<a href="Polyglot.md">Polyglot 101: Thinking in Multiple Languages</a>
<a href="Language-Guides.topic">%product% Runtime: Language Guides</a>
<a href="Elide-Framework.md">%product% Framework: Using %product% from JVM</a>
</category>
</seealso>
9 changes: 9 additions & 0 deletions Writerside/topics/Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,3 +121,12 @@ Certain features are not supported on macOS yet:
At this time there are no native libs available upstream for Espresso on macOS.
Espresso ([Java on Truffle](https://www.graalvm.org/latest/reference-manual/java-on-truffle/)) is experimental and
this limitation is expected to change eventually.

<seealso>
<category ref="gettingStarted">
<a href="GettingStarted.md">Getting Started with %product%</a>
<a href="Polyglot.md">Polyglot 101: Thinking in Multiple Languages</a>
<a href="Language-Guides.topic">%product% Runtime: Language Guides</a>
<a href="Elide-Framework.md">%product% Framework: Using %product% from JVM</a>
</category>
</seealso>
Loading

0 comments on commit 27da4f7

Please sign in to comment.