Skip to content

Commit

Permalink
doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
charlesneimog committed Dec 4, 2024
1 parent ecdbe13 commit 92b3ae2
Show file tree
Hide file tree
Showing 5 changed files with 78 additions and 40 deletions.
6 changes: 6 additions & 0 deletions Documentation/patch/gui.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
<p align="center">
Here we list all the objects that are supported by the GUI module and how to use them inside your web patch.

</p>

!!! danger "Set Senders and Receivers for GUI Objects"
Again, to use **any** GUI object (except for `vu`), you **must** configure senders and receivers. This ensures all objects function properly and saves you from spending excessive time debugging your patch.
<div class="grid cards" markdown>

- :material-gesture-double-tap:{ .lg .middle } __With `plaits~` from else__
Expand Down Expand Up @@ -67,3 +70,6 @@ All `Gui` objects include options to `send` and `receive` symbols, which are ess
- **Sending messages to the Website**: Use the `receive` symbol with a `send` or `s` object to send messages from the Pd Patch to the Website.

Note that `pd4web` does not automatically intercept connections between objects, so you must explicitly use the `send` and `receive` objects to connect the GUI objects for proper communication between the Pd Patch and the Website.

!!! danger "Set Senders and Receivers for GUI Objects"
Again, to use **any** GUI object (except for `vu`), you **must** configure senders and receivers. This ensures all objects function properly and saves you from spending excessive time debugging your patch.
8 changes: 0 additions & 8 deletions Documentation/patch/problems/index.md

This file was deleted.

4 changes: 2 additions & 2 deletions Documentation/patch/problems/memory.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<h2 align="center">Memory problems</h2>

!!! bug "How to report?"
<p style="font-size: 18px">Create a new issue on [Github](https://github.com/charlesneimog/pd4web/issues){target="_blank}" or use [Google Forms](https://forms.gle/qS7YX4QzrUKNXGkU7){target="_blank"}.</p>
<p style="font-size: 14px">Create a new issue on [Github](https://github.com/charlesneimog/pd4web/issues){target="_blank"} or use [Google Forms](https://forms.gle/qS7YX4QzrUKNXGkU7){target="_blank"}.</p>


You need to define the size of memory of your patch, this is pretty simple. Big patches needs more memory, small patches needs less memory.
Expand All @@ -17,4 +17,4 @@ If you run a big patch with a small memory size you will get one error like this

!!! danger "Aborted(Cannot enlarge memory arrays to size 134225920 bytes (OOM)."

If you see this, you need to increase the memory size. You can do this in the `pd4web` configuration, using the memory input on Pd patch or the `--memory` flag in the command line.
If you see this, you need to increase the memory size. You can do this in the `pd4web` configuration, using the memory input on Pd patch or the `--memory` flag in the command line.
42 changes: 42 additions & 0 deletions Documentation/patch/problems/where-they-live.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Errors: where I see then?

<h2 align="center">Errors: where I see then?</h2>

Errors, like the memory, flutex and others are displayed in the browser's console. To help me debug effectively, it's essential to check the console logs for your browser.

---
### Google Chrome, Edge, Brave, Opera

---
<div class="grid cards" markdown>
- :fontawesome-brands-chrome: :fontawesome-brands-edge: :simple-brave: :simple-opera:
* Open the browser and press `Ctrl + Shift + J` (Windows/Linux) or `Cmd + Option + J` (macOS).
* Alternatively, go to the menu: **1)** Click on the three-dot menu in the top-right corner. **2)** Navigate to More Tools > Developer Tools. **3)** - Select the Console tab.
</div>






---
### Mozilla Firefox

---
<div class="grid cards" markdown>
- :material-firefox:
* Open the browser and press `Ctrl + Shift + K` (Windows/Linux) or `Cmd + Option + K` (macOS).
* Alternatively, go to the menu:
Click on the hamburger menu in the top-right corner.
Navigate to Web Developer > Console.
</div>





---

!!! tip "Pro Tip"
Ensure to capture any errors or warnings displayed in the console. Screenshots or copied text can help us analyze the issue faster.

58 changes: 28 additions & 30 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,50 +65,48 @@ markdown_extensions:
- def_list
- pymdownx.tasklist:
custom_checkbox: true

repo_url: https://github.com/charlesneimog/pd4web
extra_css: [extra/extra.css]
#extra_javascript: [js/index_slider.js]
# extra_javascript: [js/index_slider.js]
nav:
- Home: index.md
- Compile your patch:
- Installation: patch/install.md
- Gui Objects:
- patch/gui.md
- Compilation:
- patch/compile.md
- Website Templates:
- patch/templates/index.md
- Website Templates List:
- patch/templates/1-score.md
- patch/templates/2-hands.md
- patch/templates/3-choir.md
- patch/templates/4-p5js.md
- patch/templates/5-tutorial.md
- Problems:
- patch/problems/memory.md
- patch/problems/compilation.md
- patch/problems/flutex.md
- Uploading your patch:
- patch/upload/github.md
- patch/upload/cloudflare.md
- patch/upload/others.md
- Gui Objects: [patch/gui.md]
- Compilation: [patch/compile.md]
- Website Templates:
- patch/templates/index.md
- Website Templates List:
- patch/templates/1-score.md
- patch/templates/2-hands.md
- patch/templates/3-choir.md
- patch/templates/4-p5js.md
- patch/templates/5-tutorial.md
- Problems:
- patch/problems/where-they-live.md
- patch/problems/memory.md
- patch/problems/compilation.md
- patch/problems/flutex.md
- Uploading your patch:
- patch/upload/github.md
- patch/upload/cloudflare.md
- patch/upload/others.md
- libraries.md
- Pd4Web JavaScript Module:
- JavaScript Module: js/js.md
- js/requirements.md
- js/engine.md
- js/receive.md
- js/send.md
- js/midi.md
- Pd4Web JavaScript Module:
- JavaScript Module: js/js.md
- js/requirements.md
- js/engine.md
- js/receive.md
- js/send.md
- js/midi.md
- devs.md
# - Examples: tests/
plugins:
- search
- exclude:
glob: [tests/**/Pd4Web/**]
extra:
#alternate:
# alternate:
# - name: English
# link: /en
# lang: en
Expand Down

0 comments on commit 92b3ae2

Please sign in to comment.