updating project information

.gitignore

@@ -2,10 +2,14 @@
 node_modules/
 .idea/
 .env
+config.json
 site/
 notes.md
 package-lock.json
 
+# ONLY FOR DOCS BRANCH, ignore the server directory
+**/server/*
+
 # Ignore all files in the uploads directories
 **/uploads/*
 

README.md

@@ -11,6 +11,7 @@ The built website is created on the `gh-pages` branch.
 mkdocs.yml is a required file and sets up the navigation tree and theme for the website.
 
 ## MkDocs Theme
+
 This build makes heavy use of the MkDocs theme, [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/setup/). Use the Setup and Reference pages to add customized content.
 
 ## How to Make Changes
@@ -24,7 +25,9 @@ Make changes directly through GitHub with direct edits or pull requests.
 (See [Contributing Guidelines](./docs/CONTRIBUTING.md))
 
 ### Local Machine
+
 To edit (and optionally deploy) to the documentation website from a local machine (same steps GitHub Actions does):
+
 - Install Python (3.11 last supported at deploy)
 - Install module requirements using `pip install`. Install using the requirements.txt file in this directory.
   - Bare minimum as of 2/21/2024:
@@ -35,6 +38,3 @@ To edit (and optionally deploy) to the documentation website from a local machin
   - `git commit -m "your commit message"`
   - `git push origin docs`
 - If deploying from your local machine: run `mkdocs gh-deploy` and it will automatically build and push to the gh-pages branch and kick off GitHub Pages to run a deploy Action.
-
-
-

docs/projects/craft.md

@@ -2,6 +2,10 @@
 
 Paper Playground provides a novel way to integrate craft with STEM exploration. The paper programs can be incorporated into paper sculpture — or other craft-based objects — enabling students to personalize their learning experiences. In addition to building paper controllers (such as the RGB sliders pictured above), students might also create an entire scene or narrative around STEM concepts. This type of tangible interface links the playful affordances of paper with computational elements.
 
+![RGB sliders using markers on one paper program](../assets/rgb-sliders.png)
+
 Learn more at the [CU Craft Tech Paper Playground page](https://cucraftlab.org/paper-playground/).
 
 The Paper Playground demo projects using paper crafting are included with Paper Playground by default in *Creator* when using local storage (see `root/server/data/default-data`). Find the templates used in the demos at the [CU Craft Tech website](https://cucraftlab.org/paper-playground-templates/).
+
+![Paper frog pop open mouth to show or hide a paper program](../assets/frog-craft.png)

docs/projects/microcontroller.md

@@ -6,14 +6,21 @@ You can now communicate with microcontrollers over bluetooth! This expands the a
 
 You can create a hybrid tangible interface using paper-based events (paper movement, paper size, markers, paper overlap, etc) from Paper Playground, while triggering actuators connected to your microcontroller. Or, vice versa... take in sensor signals from your microcontroller, pipe a message to Paper Plaground, and trigger animations, sounds, speech, and anything else you can do on the web using Paper Playground!
 
-We currently have the most support for the [BBC micro:bit](), but there are bluetooth service UUIDs available for more generic microcontrollers with bluetooth capabilities.
+We currently have the most support for the [BBC micro:bit](https://makecode.microbit.org/), but there are bluetooth service UUIDs available for more generic microcontrollers with bluetooth capabilities.
 
 ## Getting Started
 
 To get started, create a `controller` component in *Creator* and select the "Bluetooth" tab. Select the bluetooth service you want to use, and then the characteristic of that service. For example, if you want to write a string to the micro:bit, select the UART service, and the RX characteristic (which is the "read" service on the micro:bit).
 
 You will find demo projects using the micro:bit installed by default in Paper Playground in the *Creator* interface (or look in the directory `root/server/data/default-data`).
 
+!!! warning
+    You will need a good understanding of the code editor, specifications, and constraints of the microcontroller you are using! For example, when using micro:bit and MakeCode, you will find that you cannot sent rapid messages over UART if you are asking the micro:bit to change its LED Matrix every time new data is received.
+
 ## Walkthrough
 
 For a complete walkthrough using the micro:bit microcontroller, see the published [Instructables] (<https://www.instructables.com/Microbit-and-Paper-Playground-Integration-for-Enha/>) or [Hackster.io project](https://www.hackster.io/brfi7385/micro-bit-and-paper-playground-tangible-virtual-interfaces-184685).
+
+## Implementation Notes and Tips
+
+- If you're using a BBC micro:bit, then make sure to look at its [Bluetooth Specifications](https://lancaster-university.github.io/microbit-docs/resources/bluetooth/bluetooth_profile.html) to understand the structure of the data you are trying to send from or to Paper Playground.