Skip to content

Commit 71f21be

Browse files
committed
Finish canonical examples
1 parent c14cb8f commit 71f21be

File tree

3 files changed

+20
-23
lines changed

3 files changed

+20
-23
lines changed

docs/CanonicalExamples.md

Lines changed: 12 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,7 @@ nav_order: 4
77
As part of MSML, there are multiple canonical examples which are meant to showcase how the library gets used. The table below describes the features that each one has as well as the level of completion for each.
88

99

10-
## Canonical Examples
11-
12-
[Dummy/Starter Repository](https://github.com/BlockScience/MSML/tree/main/examples/StarterRepo)
13-
[Root Finding Simulation](https://github.com/SeanMcOwen/Root-Finding-Simulation)
14-
15-
### Comparison of Canonical Example Features
10+
## Comparison of Canonical Examples
1611

1712
| Feature/Attribute | [MSML Template](https://github.com/BlockScience/MSML-Template) | [Predator Prey](https://github.com/BlockScience/Predator-Prey-MSML) | [Root Finding](https://github.com/SeanMcOwen/Root-Finding-Simulation) | [Retirement Planning](https://github.com/BlockScience/Retirement-Planning-MSML) |
1813
| --- | --- | --- | --- | --- |
@@ -21,19 +16,14 @@ As part of MSML, there are multiple canonical examples which are meant to showca
2116
| Code Implementations Complete? | X | X | | WIP |
2217
| Simulations/Experiments Complete? | X | WIP| | |
2318
| Comes with tutorial? | | | | WIP |
24-
25-
| Action Transmission Channels | X | X |
26-
| Stack Block | X | X |
27-
| Parallel Block | | X |
28-
| Split Block | | |
29-
| Boundary Actions | X | |
30-
| Control Actions | X | X |
31-
| Entities | X | |
32-
| Mechanisms | X | X |
33-
| Parameters | X | X |
34-
| Policies | X | X |
35-
| Spaces | X | X |
36-
| State | X | X |
37-
| Stateful Metrics | | |
38-
| State Update Transmission Channels | X | X |
39-
| Reports | X | X |
19+
| Boundary Actions | X | X | | X |
20+
| Control Actions | X | X | X | X |
21+
| Policies | X | X | X | X |
22+
| Mechanisms | X | X | X | X |
23+
| Displays | X | X | X | X |
24+
| Parallel Block | X | X | X | X |
25+
| Stack Block | X | X | X | X |
26+
| Split Block | | | | |
27+
| Looping Block | | | | WIP |
28+
| Stateful Metrics| X | X | X | X |
29+
| Metrics | X | X | X | X |

docs/GettingStarted.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ nav_order: 2
44
layout: page
55
---
66

7-
Getting started
7+
Placeholder for getting started guide

docs/TechnicalDocumentation.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Technical Documentation
3+
layout: page
4+
nav_order: 3
5+
---
6+
7+
Placeholder for future documentation on all the technical details of MSML

0 commit comments

Comments
 (0)