🔤 (./docs) add README.md

docs/.vitepress/config.ts

@@ -65,6 +65,7 @@ export default {
           { text: "Web3 Foundation Workshop", link: "Notes/web3foundation" },
           { text: "Braindump Figma", link: "Notes/Todo-Figma" },
           { text: "Random", link: "Notes/notes" },
+          /*<CONTRIUBTION>*/
         ],
       },
     ],

docs/Organisation.org

@@ -268,7 +268,7 @@ CLOCK: [2023-11-15 Wed 08:29]--[2023-11-15 Wed 09:30] =>  1:01
 - [X] Docs
   - [X] Write Tuesday.md
 
-** TODO [#A] Last 4 days [19/22]
+** TODO [#A] Last 4 days [22/22]
 :LOGBOOK:
 CLOCK: [2023-11-25 Sat 05:30]--[2023-11-25 Sat 06:32] =>  1:02
 CLOCK: [2023-11-24 Fri 16:21]--[2023-11-24 Fri 17:18] =>  0:57
@@ -313,6 +313,30 @@ CLOCK: [2023-11-21 Tue 07:30]--[2023-11-21 Tue 08:46] =>  1:16
 - [X] write Thanks.md
 - [X] update README.md
 - [X] positioned camera somehow
+- [X] recompile .mind targets(Port to next section)
+  - [X] rename image
+  - [X] fix compile errors
+    - [X] read the articles
+    - [X] change mindar version
+    - [X] ...
+    - [X] get a life crisis
+- [X] make one button for Ramen Smart Contract (port to next section)
+- [X] arange layout (port to next section)
+  - [X] add black box bottom
+  - [X] add ar view top
+  - [X] add button 2 button in black box
+
+
+** TODO [#C After Submission Deadline [3/6]
+:LOGBOOK:
+CLOCK: [2023-11-25 Sat 11:20]--[2023-11-25 Sat 12:06] =>  0:46
+CLOCK: [2023-11-25 Sat 10:25]--[2023-11-25 Sat 11:07] =>  0:42
+CLOCK: [2023-11-25 Sat 08:35]--[2023-11-25 Sat 09:50] =>  1:15
+:END:
+- [X] Port issues from previous section
+- [X] add README.md to SmartContract
+- [X] update README.md to UiUx
+- [ ] update README.md in Backend
 - [-] recompile .mind targets
   - [ ] rename image
   - [-] fix compile errors

docs/README.md

@@ -0,0 +1,41 @@
+# Docs
+
+These are the docs.
+
+It uses Vitepress.
+
+The deployed docs are avaialbe under
+[www.key3d.surge.sh](https://key3d.surge.sh) .
+
+There are 4 folders
+
+- `./Intro` - contains Intro Section
+- `./Journey` - contains Journey of Development
+- `./Outro` - contains Outro Section
+- `./Notes` - contains diverse
+
+### Quickstart
+
+- `npm install`
+- `npx vitepress`
+- Go to http://localhost:5173
+
+### Contribute
+
+- `gh repo clone FrankBevr/key3d`
+- `cd key3d/docs`
+- `touch ./Notes/MyContribution.md`
+- `echo "This is my Contribution" >> ./Notes/MyContribution.md`
+- `./contribute.sh`
+
+- `git status`
+- `git add ./Notes/MyContribution.md`
+- `git add ./.vitepress/config.ts`
+- `git status`
+- `git commit -m ":abc: (./docs) add MyContribution.md`
+- `git status`
+- `gh pr create --title "My Contribution" --body "This is a Pull Request, merge it please"`
+- Go to https://github.com/FrankBevr/key3D/pulls to see your Contribution
+  pending.
+- After merge you see your Contribution under
+  `https://key3d.surge.sh/Notes/MyContribution.html`

docs/contribute.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+file_path="./.vitepress/config.ts"
+
+# Check if the file exists
+if [ -f "$file_path" ]; then
+    # Add the new line above /*<CONTRIUBTION>*/ using sed
+    sed -i '/\/\*<CONTRIUBTION>\*\//i\{ text: "MyContribution", link: "Notes\/MyContribution" },' "$file_path"
+    echo "Line added successfully!"
+else
+    echo "File not found."
+fi