Add documents for intended structure

miking-lang · Sep 28, 2023 · 0c286b9 · 0c286b9
1 parent 0fd21c4
commit 0c286b9
Show file tree

Hide file tree

Showing 11 changed files with 75 additions and 22 deletions.
diff --git a/docs/explanations/mcore.md b/docs/explanations/mcore.md
@@ -0,0 +1,7 @@
+# MCore, MExpr, and MLang: the Core of Miking
+
+:::note
+
+This file represents intended content, but we haven't written the content yet.
+
+:::
diff --git a/docs/how-to-guides/installing-miking.md b/docs/how-to-guides/installing-miking.md
@@ -0,0 +1,11 @@
+---
+sidebar_position: 1
+---
+
+# Installing Miking
+
+:::note
+
+This file represents intended content, but we haven't written the content yet.
+
+:::
diff --git a/docs/how-to-guides/installing.md b/docs/how-to-guides/installing.md
diff --git a/docs/how-to-guides/profiling.md b/docs/how-to-guides/profiling.md
@@ -0,0 +1,7 @@
+# Profiling MCore Programs
+
+:::note
+
+This file represents intended content, but we haven't written the content yet.
+
+:::
diff --git a/docs/index.md b/docs/index.md
@@ -6,7 +6,13 @@ id: root
 
 Miking is a meta-language system for creating embedded languages, and this site holds its documentation.
 
-We are currently in the process of restructuring our documentation (see [here](https://documentation.divio.com/) for more information on the intent), thus some information can be found in the first four categories below (where they should be) and some can be found in the fifth category.
+To get started, first [install Miking](./how-to-guides/installing-miking.md), then [write your first program](./tutorials/writing-your-first-program.md) and [write your first language](./tutorials/arithmetic-language.md).
+
+:::warning
+
+We are currently in the process of restructuring our documentation (see [here](https://documentation.divio.com/) for more information on the intent), thus some information can be found in the first four categories below (where they should be) and some can be found under [old content](#old-content) below.
+
+:::
 
 ## Content
 

diff --git a/docs/reference/intrinsics.md b/docs/reference/intrinsics.md
@@ -0,0 +1,7 @@
+# Intrinsic Functions
+
+:::note
+
+This file represents intended content, but we haven't written the content yet.
+
+:::
diff --git a/docs/reference/mexpr.md b/docs/reference/mexpr.md
@@ -0,0 +1,7 @@
+# Syntax and Semantics of MExpr
+
+:::note
+
+This file represents intended content, but we haven't written the content yet.
+
+:::
diff --git a/docs/reference/mlang.md b/docs/reference/mlang.md
@@ -0,0 +1,7 @@
+# Syntax and Semantics of MLang
+
+:::note
+
+This file represents intended content, but we haven't written the content yet.
+
+:::
diff --git a/docs/tutorials/arithmetic-language.md b/docs/tutorials/arithmetic-language.md
@@ -0,0 +1,11 @@
+---
+sidebar_position: 2
+---
+
+# Creating a Calculator Language With MLang
+
+:::note
+
+This file represents intended content, but we haven't written the content yet.
+
+:::
diff --git a/docs/tutorials/installing.md b/docs/tutorials/installing.md
diff --git a/docs/tutorials/writing-your-first-program.md b/docs/tutorials/writing-your-first-program.md
@@ -0,0 +1,11 @@
+---
+sidebar_position: 1
+---
+
+# Writing Your First Program
+
+:::note
+
+This file represents intended content, but we haven't written the content yet.
+
+:::