Update documentation

tolauwae · tolauwae · commit 71356955dcdc · 2024-02-22T13:28:33.000+01:00
diff --git a/warduino/.vitepress/components/home.vue b/warduino/.vitepress/components/home.vue
@@ -128,7 +128,7 @@ const {frontmatter: fm} = useData()
             associated software.
             You can find out more about the research on the <i>published articles</i> page.
           </p>
-          <p class="center"><a href="./articles/index.html">-&gt; Published articles</a></p>
+          <p class="center"><a href="./articles/">-&gt; Published articles</a></p>
 
           <h2></h2>
 
diff --git a/warduino/.vitepress/config.ts b/warduino/.vitepress/config.ts
@@ -117,10 +117,7 @@ export default defineConfig({
 
       {
         text: 'Published Articles',
-        collapsed: true,
-        items: [
-            { text: 'Overview', link: '/articles/' },
-        ]
+        link: '/articles/'
       }
     ],
 
@@ -141,4 +138,4 @@ pluginOptions: {
     }
   }
 },
- */
+ */
diff --git a/warduino/articles/index.md b/warduino/articles/index.md
@@ -4,15 +4,38 @@ import citation from '../.vitepress/components/citation.vue'
 
 # Published Articles
 
-## EDWARD (2022)
+## WARDuino 2.0 (2024)
+
+<citation file="/cola.bib" url= "https://doi.org/10.1016/j.cola.2024.101268" />
+
+The updated WARDuino virtual machine, has an extended debugger API, support for asynchronous callbacks, networking primitives, improved testing, and wider platform support. This paper represent the research side of the new version, and gives the first comprehensive overview of the virtual machine.
 
-EDWARD is the novel <i>out-of-place</i> debugger for WARDuino, developed to simplify debugging concurrent programs. The EDWARD debugger allows developers to debug programs largely on their own laptop—thereby enabling more advanced debugging techniques—while using a remote microcontroller as a zombie that can still provide realtime peripheral data. Asynchronous events on the remote zombie are captured by the local debugger, and a new set of debugging instructions give developers control over the timings of the events. [-> EDWARD reference](/reference/edward/)
+[-> technical reference](/reference/architecture.html)
+
+## EDWARD (2022)
 
 <citation file="/edward.bib" url="https://doi.org/10.1145/3546918.3546920"/>
 
-## WARDuino (2019)
+EDWARD is the novel <i>out-of-place</i> debugger for WARDuino, developed to simplify debugging concurrent programs. The EDWARD debugger allows developers to debug programs largely on their own laptop—thereby enabling more advanced debugging techniques—while using a remote microcontroller as a zombie that can still provide realtime peripheral data. Asynchronous events on the remote zombie are captured by the local debugger, and a new set of debugging instructions give developers control over the timings of the events. 
 
-WARDuino was the first WebAssembly virtual machine to target microcontrollers, such as the ESP32s, and included a remote debugger and support for partial over-the-air reprogramming of the devices. [-> WARDuino reference](/reference/)
+[-> technical reference](/reference/edward/)
+
+<a href="https://tolauwae.github.io/mplr22/" target="_blank">-&gt; conference slides <span class="icon material-symbols-rounded">open_in_new</span></a>
+
+## WARDuino (2019)
 
 <citation file="/warduino.bib" url="https://doi.org/10.1145/3357390.3361029" />
 
+WARDuino was the first WebAssembly virtual machine to target microcontrollers, such as the ESP32s, and included a remote debugger and support for partial over-the-air reprogramming of the devices.
+
+[-> technical reference](/reference/architecture.html)
+
+<style>
+@import "https://fonts.googleapis.com/css2?family=Material+Symbols+Rounded:opsz,wght,FILL,GRAD@20..48,100..700,0..1,-50..200";
+
+span.icon {
+    font-size: inherit;
+    font-weight: inherit;
+    vertical-align: text-top;
+}
+</style>
diff --git a/warduino/guide/latch.md b/warduino/guide/latch.md
@@ -2,7 +2,8 @@
 title: Latch
 next: Developer's Guide
 ---
-# Testing: Latch framework
+
+# Testing on Hardware
 
 **<span style="font-variant: small-caps;">Latch</span> (Large-scale Automated Testing on Constraint Hardware)** is a novel testing framework for running large scale unit and integration tests in constrained environments.
 
diff --git a/warduino/public/cola.bib b/warduino/public/cola.bib
@@ -0,0 +1,16 @@
+@Article{	  lauwaerts24,
+  title		= {{{WARDuino}}: {{An}} Embedded {{WebAssembly}} Virtual
+		  Machine},
+  shorttitle	= {{{WARDuino}}},
+  author	= {Lauwaerts, Tom and Singh, Robbert Gurdeep and Scholliers,
+		  Christophe},
+  year		= {2024},
+  month		= feb,
+  journal	= {Journal of Computer Languages},
+  pages		= {101268},
+  issn		= {2590-1184},
+  doi		= {10.1016/j.cola.2024.101268},
+  keywords	= {Internet-of-Things,Language symbiosis,Virtual
+		  machine,WARDuino,WebAssembly}
+}
+
diff --git a/warduino/reference/contributing.md b/warduino/reference/contributing.md
@@ -19,4 +19,44 @@ html.dark .low {
     background-color: rgba(46, 160, 67, 0.15);
 border-color: rgba(46, 160, 67, 0.4);
 }
-</style>
+</style>
+
+## ✨ How Can I Contribute?
+
+If you want to help with development, issues on the [roadmap](https://github.com/orgs/TOPLLab/projects/1) with low priority are a good starting point.
+
+Any sort of contribution is welcome! Including, but not limited to:
+
+- Report a bug you identified
+- Write code which enhances the system or fixes an issue
+- PRs that port WARDuino to new platforms, and tutorials to use WARDuino on new boards
+
+## 🎨 Style Guide
+
+### Commit Messages
+
+- Capitalize the first line and each paragraph
+- Use present tense (_"Add feature ..."_ instead of _"Added feature ..."_)
+- Use the imperative mood (_"Fix delay ..."_ instead of _"Fixes delay ..."_)
+- Do not end the subject line with a period
+- Use the body to explain what and why you have done something, refer to issues and PRs if you want
+
+Check out the [guidelines for commit messages](https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53) for more examples and recommendations.
+
+### Branches
+
+- Follow a simple naming scheme that clearly describes the topic you are working on
+
+### Pull Requests
+
+- Use the description field to describe what you are introducing or changing in your branch
+- Try to make small PRs that fix/introduce a single item
+
+### Merge Branches
+
+- You cannot push directly to `main`, please create a branch with your changes and open a PR to request code review before merging
+- You can use a ["Draft" PR](https://github.blog/2019-02-14-introducing-draft-pull-requests/) if your work is not done yet
+- Verify that all status checks are passing
+- Click "Ready to Review" to request merging your branch into `main`
+- Since PRs should introduce a single cohesive change to the code, the preferred merge method is [Squash and merge](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#squash-and-merge-your-commits)
+
diff --git a/warduino/reference/debug-protocol.md b/warduino/reference/debug-protocol.md
@@ -3,9 +3,9 @@ next: EDWARD
 ---
 # Debug Protocol Reference Sheet
 
-::: tip Debug protocol 0.4.2
+::: tip Debug protocol 0.4.3
 
-This page describes the debug protocol of WARDuino [version 0.4.2](https://github.com/TOPLLab/WARDuino/releases/tag/v0.4.2).
+This page describes the debug protocol of WARDuino [version 0.4.3](https://github.com/TOPLLab/WARDuino/releases/tag/v0.4.3).
 
 :::
 

Original file line number	Diff line number	Diff line change
`@@ -117,10 +117,7 @@ export default defineConfig({`
`117`	`117`
`118`	`118`	`{`
`119`	`119`	`text: 'Published Articles',`
`120`		`- collapsed: true,`
`121`		`- items: [`
`122`		`- { text: 'Overview', link: '/articles/' },`
`123`		`- ]`
	`120`	`+ link: '/articles/'`
`124`	`121`	`}`
`125`	`122`	`],`
`126`	`123`
`@@ -141,4 +138,4 @@ pluginOptions: {`
`141`	`138`	`}`
`142`	`139`	`}`
`143`	`140`	`},`
`144`		`- */`
	`141`	`+ */`