Merge pull request #6 from aayush-tripathi/docs/mdbook-setup

Docs/mdbook setup

Author: aayush-tripathi

.github/workflows/mdbook.yml

@@ -0,0 +1,34 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches: [master]        # build on every push to master
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install mdBook
+        run: cargo install mdbook 
+
+      - name: Build book
+        run: mdbook build docs
+
+      # Upload the generated site as an artifact that Pages can deploy
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/book
+
+  deploy:
+    needs: build
+    permissions:
+      pages: write           # to push to gh-pages
+      id-token: write
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deploy.outputs.page_url }}
+    steps:
+      - uses: actions/deploy-pages@v4
+        id: deploy

.gitignore

@@ -1,3 +1,5 @@
 # Rust build artifacts
 target/
-tundra/target/
+tundra/target/
+# mdBook build output
+/docs/book/

docs/.gitignore

@@ -0,0 +1 @@
+book

docs/book.toml

@@ -0,0 +1,7 @@
+[book]
+title = "The Tundra Language Reference"
+author = "Aayush Tripathi"
+language = "en"
+description = "This book is a reference on the syntax and workig of Tundra!"
+[output.html]
+default-theme = "light"

docs/src/SUMMARY.md

@@ -0,0 +1,10 @@
+# Summary
+
+[Introduction](./intro.md)
+
+- [Syntax Overview](./syntax.md)
+- [Literals](./literals.md)
+- [Operators](./operators.md)
+- [Control Flow](./control_flow.md)
+- [Functions & Classes](./functions.md)
+- [Standard Library](./stdlib.md)

docs/src/control_flow.md

@@ -0,0 +1,42 @@
+# Control Flow
+
+### `if` / `else`
+- Tundra supports regular `if`/`else` statements like python.
+- The condition must be wrapped around parenthesis 
+```tundra
+if (condition):
+    # true branch
+    print("Yes")
+else:
+    # false branch
+    print("No")
+```
+
+### `while`
+- Tundra supports regular `while` statements like python.
+- The condition must be wrapped around parenthesis 
+```tundra
+var i = 0
+while (i < 5):
+    print(i)
+    i = i + 1
+```
+
+### `for over range()`
+- Tundra supports regular `for` statements like python.
+```tundra
+for i in range(3):
+    print(i)
+```
+
+### `break` and `continue`
+- - Tundra supports regular `break` and `continue` statements like python.
+```tundra
+for i in range(10):
+    if (i == 3):
+        break
+    if (i % 2 == 0):
+        continue
+    print(i)
+```
+

docs/src/custom.css

@@ -0,0 +1,9 @@
+.book .navbar .title {
+  font-size: 1.5em;
+  background: url('../images/tundraLogo.png') no-repeat left center;
+  padding-left: 1.5em;
+}
+
+.book .content code {
+  background-color: #f0f0f0;
+}

docs/src/functions.md

@@ -0,0 +1,40 @@
+# Functions & Classes
+
+## Function Declaration
+
+```tundra
+fun add(a, b):
+    return a + b
+```
+The functions in tundra follow a very pythonic syntax
+- Need to begin with `fun` keyword
+- Followed by function name and parameters 
+- Colon to begin definition
+- Indent and followed by a regular code 
+
+### Example
+```tundra
+fun fib(n):
+    if (n < 2):
+        return n
+    return fib(n - 1) + fib(n - 2)
+print(fib(10))
+
+```
+#### Bytecode
+```bytecode
+== == Disassembled Bytecode == ==
+0000 Line    6    LoadConstant(0, Value { value: Function(RefCell { value: FunctionObject { name: "fib", arity: 1, chunk: RefCell { value: Chunk { code: [GetLocal(1, 0), Move(2, 1), LoadConstant(3, Value { value: Int(2) }), Less(4, 2, 3), JumpIfFalse(4, 2), GetLocal(3, 0), Return(3), GetGlobal(4, "fib"), GetLocal(3, 0), Move(2, 3), LoadConstant(5, Value { value: Int(1) }), Subtract(6, 2, 5), Move(5, 6), Call(5, 4, 1), Move(4, 5), GetGlobal(6, "fib"), GetLocal(2, 0), Move(7, 2), LoadConstant(8, Value { value: Int(2) }), Subtract(9, 7, 8), Move(7, 9), Call(8, 6, 1), Add(6, 4, 8), Return(6), Return(0)], constants: [], lines: [3, 3, 3, 3, 3, 4, 4, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 6], max_register: 10 } }, jitted: None } }) })
+0001 Line    6    DefineGlobal(0, "fib")
+0002 Line    6    GetGlobal(0, "fib")
+0003 Line    6    LoadConstant(1, Value { value: Int(10) })
+0004 Line    6    Call(2, 0, 1)
+0005 Line    6    Print(2)
+0006 Line    7    Return(2)
+```
+#### Output 
+    55
+---
+## Class Declaration
+
+- To be implemented

docs/src/images/tundraLogo.png

@@ -0,0 +1,5 @@
+# Introduction
+
+Welcome to **Tundra**!  
+Tundra is a Python-like, register-based language implemented in Rust.  
+This Wiki is here to help users use, understand and contribute to Tundra.