Skip to content

Commit 7fb9012

Browse files
committed
Deployed 36a9cd6 with MkDocs version: 1.6.1
1 parent d8e2074 commit 7fb9012

File tree

6 files changed

+107
-80
lines changed

6 files changed

+107
-80
lines changed

develop/contributing/index.html

Lines changed: 46 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -446,7 +446,7 @@ <h1 class="scroll-m-20 text-4xl font-semibold tracking-tight sm:text-3xl xl:text
446446
<script>
447447
const updatedAt = document.getElementById("updated_at");
448448
if (updatedAt) {
449-
const date = new Date('2025-09-03T09:45:25+02:00');
449+
const date = new Date('2025-09-04T11:13:27+02:00');
450450
updatedAt.textContent = date.toLocaleDateString();
451451
}
452452
</script>
@@ -456,53 +456,62 @@ <h1 class="scroll-m-20 text-4xl font-semibold tracking-tight sm:text-3xl xl:text
456456

457457
</div>
458458
<div class="typography w-full flex-1 *:data-[slot=alert]:first:mt-0">
459-
<p>Contributions to the CSM project are highly welcome. There are several ways you can get involved, whether by
460-
improving the runtime system, advancing research, or supporting related tools and documentation.</p>
461-
<h3 id="where-to-start-contributing">Where to start contributing</h3>
459+
<p>Contributions to the CSM project are highly welcome.</p>
460+
<p>There are several ways you can get involved, whether by <strong>improving the runtime system</strong>,
461+
<strong>advancing research</strong>, or <strong>supporting related tools and documentation</strong>.</p>
462+
<h2 id="where-to-start-contributing">Where to Start Contributing</h2>
462463
<ul>
463464
<li>
464-
<p><strong>Cirrina Runtime System</strong><br />
465-
The official runtime system for CSM is available as an open-source project on <a href="https://github.com/CollaborativeStateMachines/Cirrina">GitHub
466-
<svg class="iconify" xmlns="http://www.w3.org/2000/svg" width="20px" height="20px" viewBox="0 0 24 24"><path fill="currentColor" d="M12 1C5.923 1 1 5.923 1 12c0 4.867 3.149 8.979 7.521 10.436c.55.096.756-.233.756-.522c0-.262-.013-1.128-.013-2.049c-2.764.509-3.479-.674-3.699-1.292c-.124-.317-.66-1.293-1.127-1.554c-.385-.207-.936-.715-.014-.729c.866-.014 1.485.797 1.691 1.128c.99 1.663 2.571 1.196 3.204.907c.096-.715.385-1.196.701-1.471c-2.448-.275-5.005-1.224-5.005-5.432c0-1.196.426-2.186 1.128-2.956c-.111-.275-.496-1.402.11-2.915c0 0 .921-.288 3.024 1.128a10.2 10.2 0 0 1 2.75-.371c.936 0 1.871.123 2.75.371c2.104-1.43 3.025-1.128 3.025-1.128c.605 1.513.221 2.64.111 2.915c.701.77 1.127 1.747 1.127 2.956c0 4.222-2.571 5.157-5.019 5.432c.399.344.743 1.004.743 2.035c0 1.471-.014 2.654-.014 3.025c0 .289.206.632.756.522C19.851 20.979 23 16.854 23 12c0-6.077-4.922-11-11-11"/></svg></a>. Contributions to Cirrina
467-
can include bug fixes, feature implementations, performance improvements, or enhancing documentation.</p>
465+
<p><strong>Contributing to Cirrina</strong><br />
466+
The official runtime system for CSM is available as an <strong>open-source project</strong> on <a href="https://github.com/CollaborativeStateMachines/Cirrina">GitHub <svg class="iconify" xmlns="http://www.w3.org/2000/svg" width="20px" height="20px" viewBox="0 0 24 24"><path fill="currentColor" d="M12 1C5.923 1 1 5.923 1 12c0 4.867 3.149 8.979 7.521 10.436c.55.096.756-.233.756-.522c0-.262-.013-1.128-.013-2.049c-2.764.509-3.479-.674-3.699-1.292c-.124-.317-.66-1.293-1.127-1.554c-.385-.207-.936-.715-.014-.729c.866-.014 1.485.797 1.691 1.128c.99 1.663 2.571 1.196 3.204.907c.096-.715.385-1.196.701-1.471c-2.448-.275-5.005-1.224-5.005-5.432c0-1.196.426-2.186 1.128-2.956c-.111-.275-.496-1.402.11-2.915c0 0 .921-.288 3.024 1.128a10.2 10.2 0 0 1 2.75-.371c.936 0 1.871.123 2.75.371c2.104-1.43 3.025-1.128 3.025-1.128c.605 1.513.221 2.64.111 2.915c.701.77 1.127 1.747 1.127 2.956c0 4.222-2.571 5.157-5.019 5.432c.399.344.743 1.004.743 2.035c0 1.471-.014 2.654-.014 3.025c0 .289.206.632.756.522C19.851 20.979 23 16.854 23 12c0-6.077-4.922-11-11-11"/></svg></a>.<br />
467+
Contributions may include:</p>
468+
<ul>
469+
<li>Bug fixes</li>
470+
<li>Feature implementations</li>
471+
<li>Performance improvements</li>
472+
<li>Documentation enhancements</li>
473+
</ul>
468474
</li>
469475
<li>
470476
<p><strong>Research</strong><br />
471-
If you use CSM in your research, or build upon publications related to the project, your insights and
472-
contributions are valuable. Relevant publications can be found <a href="../../research/publications/">here</a>.</p>
477+
If you use CSM in your research or build on our publications, your contributions are valuable.<br />
478+
Relevant publications can be found <a href="../../research/publications/">here</a>.</p>
473479
</li>
474480
<li>
475481
<p><strong>Documentation and Tutorials</strong><br />
476-
Improving tutorials, examples, or reference documentation is another way to support the project and make
477-
CSM more accessible to new users.</p>
482+
Improving tutorials, examples, and reference documentation helps make CSM more accessible to new users.</p>
478483
</li>
479484
</ul>
480485
<h3 id="contributing-to-cirrina">Contributing to Cirrina</h3>
481-
<p>Cirrina is implemented in Java and Kotlin, with Kotlin being the preferred language. Contributions can be
482-
submitted via pull requests from forks of the repository.</p>
483-
<p>To ensure smooth collaboration: </p>
486+
<p>Cirrina is implemented in <strong>Java</strong> and <strong>Kotlin</strong>, with <strong>Kotlin as the preferred language</strong>.</p>
487+
<p>Contributions are submitted via <strong>pull requests</strong> from forks of the repository.</p>
488+
<p>To ensure smooth collaboration, we:</p>
484489
<ul>
485-
<li>Follow <a href="https://github.com/conventional-changelog/commitlint">commitlint</a> conventions to keep the changelog
486-
tidy.</li>
487-
<li>Maintain and improve test coverage through our <a href="https://github.com/CollaborativeStateMachines/Cirrina/tree/develop/src/test/java/at/ac/uibk/dps/cirrina">unit tests</a>.
488-
These are automatically validated via our <a href="https://github.com/CollaborativeStateMachines/Cirrina/blob/develop/.github/workflows/build.yml">build pipeline</a>.</li>
489-
<li>Pull requests must pass all status checks and undergo code review before merging. </li>
490+
<li>follow <a href="https://github.com/conventional-changelog/commitlint">commitlint</a> conventions to keep the
491+
changelog tidy;</li>
492+
<li>use <a href="https://prettier.io/">Prettier</a> to format our code;</li>
493+
<li>maintain and improve test coverage via our <a href="https://github.com/CollaborativeStateMachines/Cirrina/tree/develop/src/test/java/at/ac/uibk/dps/cirrina">unit tests</a>
494+
validated automatically by our <a href="https://github.com/CollaborativeStateMachines/Cirrina/blob/develop/.github/workflows/build.yml">build pipeline</a>; and</li>
495+
<li>let pull requests <strong>pass all status checks</strong> and undergo <strong>code review</strong> before merging. </li>
490496
</ul>
491-
<p>We encourage contributors to discuss major changes or new features via
492-
<a href="https://github.com/CollaborativeStateMachines/Cirrina/issues">GitHub issues</a> before implementation to align
493-
with the project roadmap.</p>
494-
<p>Additionally, for broader discussions related to the CSM project, we have a
495-
<a href="https://github.com/orgs/CollaborativeStateMachines/discussions">discussion board</a>.</p>
496-
<h3 id="research-contributions">Research contributions</h3>
497497
<div class="admonition info">
498-
<p><strong>If CSM is part of your research, please cite our primary publication:</strong><br/><br/></p>
499-
<p>Marlon Etheredge, Thomas Fahringer, Felix Erlacher, Elias Kohler, Stefan Pedratscher, Juan Aznar-Poveda, Nishant Saurabh, and Adrien Lebre. Collaborative State Machines: A Better Programming Model for the Cloud-Edge-IoT Continuum. July 2025. <a href="https://arxiv.org/abs/2507.21685">arXiv:2507.21685</a>, <a href="https://doi.org/10.48550/arXiv.2507.21685">doi:10.48550/arXiv.2507.21685</a>.</p>
498+
<p>For major changes or new features, please open a <a href="https://github.com/CollaborativeStateMachines/Cirrina/issues">GitHub issue</a>
499+
to align with the project roadmap.</p>
500+
</div>
501+
<div class="admonition info">
502+
<p>Broader discussions related to the CSM project take place on our <a href="https://github.com/orgs/CollaborativeStateMachines/discussions">discussion board</a>.</p>
503+
</div>
504+
<h3 id="research">Research</h3>
505+
<p>We encourage researchers to share <strong>new findings, experiments, or insights</strong> that extend CSM. These
506+
contributions help the project evolve and guide future development.</p>
507+
<div class="admonition info">
508+
<p><strong>If CSM is part of your research, please cite our primary publication:</strong><br></p>
509+
<p><code>Marlon Etheredge, Thomas Fahringer, Felix Erlacher, Elias Kohler, Stefan Pedratscher, Juan Aznar\-Poveda, Nishant Saurabh, and Adrien Lebre. Collaborative State Machines: A Better Programming Model for the Cloud\-Edge\-IoT Continuum. July 2025. [arXiv:2507.21685](https://arxiv.org/abs/2507.21685), [doi:10.48550/arXiv.2507.21685](https://doi.org/10.48550/arXiv.2507.21685).</code></p>
500510
</div>
501-
<p>You are also encouraged to share new research findings, experiments, or insights that extend the CSM
502-
framework, as these contributions help the project evolve and guide future development.</p>
503-
<h3 id="documentation">Documentation</h3>
504-
<p>The CSM project documentation is maintained on this website. Contributions, corrections, and enhancements are
505-
welcome via pull requests to its <a href="https://github.com/CollaborativeStateMachines/collaborativestatemachines.github.io">GitHub repository <svg class="iconify" xmlns="http://www.w3.org/2000/svg" width="20px" height="20px" viewBox="0 0 24 24"><path fill="currentColor" d="M12 1C5.923 1 1 5.923 1 12c0 4.867 3.149 8.979 7.521 10.436c.55.096.756-.233.756-.522c0-.262-.013-1.128-.013-2.049c-2.764.509-3.479-.674-3.699-1.292c-.124-.317-.66-1.293-1.127-1.554c-.385-.207-.936-.715-.014-.729c.866-.014 1.485.797 1.691 1.128c.99 1.663 2.571 1.196 3.204.907c.096-.715.385-1.196.701-1.471c-2.448-.275-5.005-1.224-5.005-5.432c0-1.196.426-2.186 1.128-2.956c-.111-.275-.496-1.402.11-2.915c0 0 .921-.288 3.024 1.128a10.2 10.2 0 0 1 2.75-.371c.936 0 1.871.123 2.75.371c2.104-1.43 3.025-1.128 3.025-1.128c.605 1.513.221 2.64.111 2.915c.701.77 1.127 1.747 1.127 2.956c0 4.222-2.571 5.157-5.019 5.432c.399.344.743 1.004.743 2.035c0 1.471-.014 2.654-.014 3.025c0 .289.206.632.756.522C19.851 20.979 23 16.854 23 12c0-6.077-4.922-11-11-11"/></svg></a>.</p>
511+
<h3 id="documentation-and-tutorials">Documentation and Tutorials</h3>
512+
<p>The CSM project documentation is maintained on this website.</p>
513+
<p>Contributions, corrections, and enhancements are welcome via pull requests to its<br />
514+
<a href="https://github.com/CollaborativeStateMachines/collaborativestatemachines.github.io">GitHub repository <svg class="iconify" xmlns="http://www.w3.org/2000/svg" width="20px" height="20px" viewBox="0 0 24 24"><path fill="currentColor" d="M12 1C5.923 1 1 5.923 1 12c0 4.867 3.149 8.979 7.521 10.436c.55.096.756-.233.756-.522c0-.262-.013-1.128-.013-2.049c-2.764.509-3.479-.674-3.699-1.292c-.124-.317-.66-1.293-1.127-1.554c-.385-.207-.936-.715-.014-.729c.866-.014 1.485.797 1.691 1.128c.99 1.663 2.571 1.196 3.204.907c.096-.715.385-1.196.701-1.471c-2.448-.275-5.005-1.224-5.005-5.432c0-1.196.426-2.186 1.128-2.956c-.111-.275-.496-1.402.11-2.915c0 0 .921-.288 3.024 1.128a10.2 10.2 0 0 1 2.75-.371c.936 0 1.871.123 2.75.371c2.104-1.43 3.025-1.128 3.025-1.128c.605 1.513.221 2.64.111 2.915c.701.77 1.127 1.747 1.127 2.956c0 4.222-2.571 5.157-5.019 5.432c.399.344.743 1.004.743 2.035c0 1.471-.014 2.654-.014 3.025c0 .289.206.632.756.522C19.851 20.979 23 16.854 23 12c0-6.077-4.922-11-11-11"/></svg></a>.</p>
506515

507516
</div>
508517
</article>
@@ -745,14 +754,6 @@ <h3 id="documentation">Documentation</h3>
745754

746755

747756

748-
<a href="#where-to-start-contributing"
749-
class="text-muted-foreground hover:text-foreground data-[active=true]:text-foreground text-[0.8rem] no-underline transition-colors data-[depth=3]:pl-4 data-[depth=4]:pl-6"
750-
data-active="false" data-depth="2">
751-
Where to start contributing
752-
</a>
753-
754-
755-
756757
<a href="#contributing-to-cirrina"
757758
class="text-muted-foreground hover:text-foreground data-[active=true]:text-foreground text-[0.8rem] no-underline transition-colors data-[depth=3]:pl-4 data-[depth=4]:pl-6"
758759
data-active="false" data-depth="2">
@@ -761,18 +762,18 @@ <h3 id="documentation">Documentation</h3>
761762

762763

763764

764-
<a href="#research-contributions"
765+
<a href="#research"
765766
class="text-muted-foreground hover:text-foreground data-[active=true]:text-foreground text-[0.8rem] no-underline transition-colors data-[depth=3]:pl-4 data-[depth=4]:pl-6"
766767
data-active="false" data-depth="2">
767-
Research contributions
768+
Research
768769
</a>
769770

770771

771772

772-
<a href="#documentation"
773+
<a href="#documentation-and-tutorials"
773774
class="text-muted-foreground hover:text-foreground data-[active=true]:text-foreground text-[0.8rem] no-underline transition-colors data-[depth=3]:pl-4 data-[depth=4]:pl-6"
774775
data-active="false" data-depth="2">
775-
Documentation
776+
Documentation and Tutorials
776777
</a>
777778

778779

develop/runtime-system/index.html

Lines changed: 39 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -446,7 +446,7 @@ <h1 class="scroll-m-20 text-4xl font-semibold tracking-tight sm:text-3xl xl:text
446446
<script>
447447
const updatedAt = document.getElementById("updated_at");
448448
if (updatedAt) {
449-
const date = new Date('2025-09-03T14:15:31+02:00');
449+
const date = new Date('2025-09-04T11:13:27+02:00');
450450
updatedAt.textContent = date.toLocaleDateString();
451451
}
452452
</script>
@@ -460,19 +460,22 @@ <h1 class="scroll-m-20 text-4xl font-semibold tracking-tight sm:text-3xl xl:text
460460
<img src="../../assets/cirrina/logo.svg" width="90%" />
461461
</center>
462462

463-
<p>Cirrina is the official runtime system of the CSM project. Together with the CSM programming model, it is
464-
being developed by the <a href="https://dps.uibk.ac.at/">Distributed and Parallel Systems Group</a> at the University of
465-
Innsbruck. </p>
466-
<p>The runtime system is implemented in Java and Kotlin and is available as an open-source project on <a href="https://github.com/CollaborativeStateMachines/Cirrina">Github
467-
<svg class="iconify" xmlns="http://www.w3.org/2000/svg" width="20px" height="20px" viewBox="0 0 24 24"><path fill="currentColor" d="M12 1C5.923 1 1 5.923 1 12c0 4.867 3.149 8.979 7.521 10.436c.55.096.756-.233.756-.522c0-.262-.013-1.128-.013-2.049c-2.764.509-3.479-.674-3.699-1.292c-.124-.317-.66-1.293-1.127-1.554c-.385-.207-.936-.715-.014-.729c.866-.014 1.485.797 1.691 1.128c.99 1.663 2.571 1.196 3.204.907c.096-.715.385-1.196.701-1.471c-2.448-.275-5.005-1.224-5.005-5.432c0-1.196.426-2.186 1.128-2.956c-.111-.275-.496-1.402.11-2.915c0 0 .921-.288 3.024 1.128a10.2 10.2 0 0 1 2.75-.371c.936 0 1.871.123 2.75.371c2.104-1.43 3.025-1.128 3.025-1.128c.605 1.513.221 2.64.111 2.915c.701.77 1.127 1.747 1.127 2.956c0 4.222-2.571 5.157-5.019 5.432c.399.344.743 1.004.743 2.035c0 1.471-.014 2.654-.014 3.025c0 .289.206.632.756.522C19.851 20.979 23 16.854 23 12c0-6.077-4.922-11-11-11"/></svg></a>. </p>
468-
<p>Cirrina acts as a high-performance reference implementation of a CSM runtime system. It is designed to operate
469-
across heterogeneous environments, including cloud, edge, and IoT devices, making it suitable for a wide range
470-
of distributed computing scenarios. In addition to serving as a foundation for our research on the development
471-
of the CSM method, Cirrina provides a platform that can be extended, adapted, and evaluated by the wider
472-
community. </p>
473-
<p>We welcome contributions from researchers, practitioners, and developers interested in distributed systems,
474-
programming models, and runtime technologies. For guidelines on how to get involved, please refer to the
475-
<a href="../contributing/">contributing</a> page. </p>
463+
<p><strong>Cirrina</strong> is the official runtime system of the CSM project. Together with the CSM programming model, it is
464+
being developed by the <a href="https://dps.uibk.ac.at/">Distributed and Parallel Systems Group</a> at the University of
465+
Innsbruck.</p>
466+
<p>The runtime system is implemented in <strong>Java</strong> and <strong>Kotlin</strong> and is available as an <strong>open-source project</strong> on <a href="https://github.com/CollaborativeStateMachines/Cirrina">GitHub <svg class="iconify" xmlns="http://www.w3.org/2000/svg" width="20px" height="20px" viewBox="0 0 24 24"><path fill="currentColor" d="M12 1C5.923 1 1 5.923 1 12c0 4.867 3.149 8.979 7.521 10.436c.55.096.756-.233.756-.522c0-.262-.013-1.128-.013-2.049c-2.764.509-3.479-.674-3.699-1.292c-.124-.317-.66-1.293-1.127-1.554c-.385-.207-.936-.715-.014-.729c.866-.014 1.485.797 1.691 1.128c.99 1.663 2.571 1.196 3.204.907c.096-.715.385-1.196.701-1.471c-2.448-.275-5.005-1.224-5.005-5.432c0-1.196.426-2.186 1.128-2.956c-.111-.275-.496-1.402.11-2.915c0 0 .921-.288 3.024 1.128a10.2 10.2 0 0 1 2.75-.371c.936 0 1.871.123 2.75.371c2.104-1.43 3.025-1.128 3.025-1.128c.605 1.513.221 2.64.111 2.915c.701.77 1.127 1.747 1.127 2.956c0 4.222-2.571 5.157-5.019 5.432c.399.344.743 1.004.743 2.035c0 1.471-.014 2.654-.014 3.025c0 .289.206.632.756.522C19.851 20.979 23 16.854 23 12c0-6.077-4.922-11-11-11"/></svg></a>.</p>
467+
<h3 id="key-features">Key Features</h3>
468+
<ul>
469+
<li><strong>High-performance reference implementation</strong> of a CSM runtime system.</li>
470+
<li>Designed for <strong>heterogeneous environments</strong>: cloud, edge, and IoT devices.</li>
471+
<li>Supports a <strong>wide range of distributed computing scenarios</strong>.</li>
472+
<li>Serves as a foundation for research on the <strong>CSM method</strong>.</li>
473+
<li>Provides a platform that can be <strong>extended, adapted, and evaluated</strong> by the wider community.</li>
474+
</ul>
475+
<h3 id="get-involved">Get Involved</h3>
476+
<p>We welcome contributions from <strong>researchers, practitioners, and developers</strong> interested in distributed
477+
systems, programming models, and runtime technologies.</p>
478+
<p>For guidelines on how to participate, please see <a href="../contributing/">Contributing</a>.</p>
476479

477480
</div>
478481
</article>
@@ -712,6 +715,28 @@ <h1 class="scroll-m-20 text-4xl font-semibold tracking-tight sm:text-3xl xl:text
712715
<div class="flex flex-col gap-2 p-4 pt-0 text-sm">
713716
<p class="text-muted-foreground bg-background sticky top-0 h-6 text-xs">On This Page</p>
714717

718+
719+
720+
721+
<a href="#key-features"
722+
class="text-muted-foreground hover:text-foreground data-[active=true]:text-foreground text-[0.8rem] no-underline transition-colors data-[depth=3]:pl-4 data-[depth=4]:pl-6"
723+
data-active="false" data-depth="2">
724+
Key Features
725+
</a>
726+
727+
728+
729+
<a href="#get-involved"
730+
class="text-muted-foreground hover:text-foreground data-[active=true]:text-foreground text-[0.8rem] no-underline transition-colors data-[depth=3]:pl-4 data-[depth=4]:pl-6"
731+
data-active="false" data-depth="2">
732+
Get Involved
733+
</a>
734+
735+
736+
737+
738+
739+
715740

716741
</div>
717742
<div class="h-12"></div>

0 commit comments

Comments
 (0)