Update docs

nitis-languages · Sep 19, 2024 · ea3bacd · ea3bacd
1 parent 3d8b0dc
commit ea3bacd
Show file tree

Hide file tree

Showing 10 changed files with 51 additions and 17 deletions.
diff --git a/docs/guidelines/coding-style.md b/docs/guidelines/coding-style.md
@@ -0,0 +1,23 @@
+---
+icon: material/code-braces
+description: Hi
+---
+# Coding style
+
+Consistent code style is good practice to keep code more readable across whole project, that makes it more readable and makes it easier to collaborate within a development team or contributors.
+
+## Language guidelines
++ Prefer modern features and constructions than older ones
++ Use latest language version (whenever it possible)
++ Use language keywords for data types instead of them full name:
+	+ `u32` but not `std::numerics::UInt32` nor `UInt32`
+
+## Prefer *fast* boolean operators
++ Use fast `&&` and `||` boolean operators instead of `&` and `|` operators
+
+## Style prefer
++ Use [K&R](https://en.wikipedia.org/wiki/Indentation_style#K&R) style for braces
++ Prefer tabulation than spaces
+	+ If spaces is used: use 4 spaces for indentation
+	+ Store prefered indentation style to `.editorconfig` file of your project
++ Do not make too long lines
diff --git a/docs/guidelines/naming-guideline.md b/docs/guidelines/naming-guideline.md
@@ -1,3 +1,7 @@
+---
+icon: material/format-font
+---
+
 # Naming guidelines
 
 !!! warning

diff --git a/docs/index.md b/docs/index.md
@@ -4,8 +4,6 @@ hide:
   - toc
 ---
 
-# Home
-
 !!! warning
 
     Site still in developing...

diff --git a/docs/runtime/bytecode/break.md b/docs/runtime/bytecode/break.md
@@ -1,3 +1,6 @@
+---
+icon: material/cog-box
+---
 # `break` instruction
 Signals the NLR to inform debugger that a break point is been reached
 

diff --git a/docs/runtime/bytecode/nope.md b/docs/runtime/bytecode/nope.md
@@ -1,3 +1,6 @@
+---
+icon: material/cog-box
+---
 # `nope` instruction
 Does nothing
 

diff --git a/docs/runtime/bytecode/pop.md b/docs/runtime/bytecode/pop.md
diff --git a/docs/runtime/bytecode/push.md b/docs/runtime/bytecode/push.md
@@ -1,3 +1,6 @@
+---
+icon: material/cog-box
+---
 # `push` instructions
 Push instructions are pushing values onto stack for future using
 

diff --git a/docs/runtime/bytecode/store.md b/docs/runtime/bytecode/store.md
@@ -0,0 +1,9 @@
+---
+icon: material/cog-box
+---
+# `store` instructions
+
+!!! warning
+
+    Site still in developing...
+    Please wait
diff --git a/docs/runtime/list_of_all_bytecodes.md b/docs/runtime/list_of_all_bytecodes.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -135,7 +135,11 @@ extra:
 nav:
   - index.md
   - Runtime:
-    - runtime/versions/zero.md
-    - runtime/list_of_all_bytecodes.md
+    - Bytecodes:
+      - runtime/bytecode/nope.md
+      - runtime/bytecode/break.md
+      - runtime/bytecode/push.md
+      - runtime/bytecode/store.md
   - Guidelines:
+    - guidelines/coding-style.md
     - guidelines/naming-guideline.md