Deployed bc021c3 with MkDocs version: 1.6.0

StarBase/Contribute/index.html

@@ -1916,23 +1916,23 @@
   <h1>Contribute</h1>
 
 <h2 id="contribute">Contribute</h2>
-<p>If you want to help with StarMod, the following needs helping hands:</p>
+<p>If you want to help with StarMod, the following items could use helping hands:</p>
 <p>StarBase:</p>
 <ul>
 <li>Custom bin name - Small, see also <a href="https://github.com/ewowi/StarBase/issues/48">issues/48</a> 🚧</li>
-<li>Improve UI - big see <a href="https://github.com/ewowi/StarBase/issues/54">issues/54</a></li>
-<li>Setup StarMod.org (StarBase.org?) - medium</li>
-<li>Print to different targets (Serial, file, net) - medium 🚧</li>
+<li>Improve UI - Big, see <a href="https://github.com/ewowi/StarBase/issues/54">issues/54</a></li>
+<li>Setup StarMod.org (StarBase.org?) - Medium</li>
+<li>Print to different targets (Serial, file, net) - Medium 🚧</li>
 <li>Promote StarBase to other communities eg Fastled community</li>
-<li>Improve pins viewer, see <a href="https://github.com/thelastoutpostworkshop/gpio_viewer/issues/110">gpio viewer</a> - big 🚧</li>
+<li>Improve pins viewer, see <a href="https://github.com/thelastoutpostworkshop/gpio_viewer/issues/110">gpio viewer</a> - Big 🚧</li>
 <li>Example AppModules (eg FastLed, blink, pin high/low, gyro viewer, ...) see <a href="https://github.com/ewowi/StarBase/issues/50">issues/50</a></li>
 <li>synchronized time within 20ms between instances (look for Toki::Time and timebase)</li>
 <li>...</li>
 </ul>
 <p>StarLeds</p>
 <ul>
-<li>create new effects - Medium</li>
-<li>create new projections - Medium</li>
+<li>Create new effects - Medium</li>
+<li>Create new projections - Medium</li>
 <li>Fixture generator preview - Medium</li>
 <li>Generate your fixture - Medium<ul>
 <li><a href="https://3dwarehouse.sketchup.com/model/e9de47b1-02f6-4677-a2ad-e73c1af6442f/Burning-Man-Effigy">burning man</a> - create conversion script between 3D models and StarLeds </li>

StarBase/Development/index.html

@@ -1919,23 +1919,23 @@ <h2 id="development">Development</h2>
 <p>Process</p>
 <ul>
 <li>Check <a href="/StarDocs/StarBase/Contribute/">Contribute</a></li>
-<li>Decide if it is a StarBase or StarLeds change</li>
-<li>For Medium to big changes: create a github issue to document the design of the change</li>
-<li>Fork one of the repos (StarBase or StarLeds)</li>
+<li>Determine if it is a StarBase or StarLeds change</li>
+<li>For medium to big changes: create a GitHub issue to document the design of the change</li>
+<li>Fork the appropriate (StarBase or StarLeds)</li>
 <li>Create a branch (more text needed here) for medium or big changes (small can be done on main)</li>
-<li>Implement change</li>
+<li>Implement your change</li>
 <li>Follow the <a href="https://ewowi.github.io/StarDocs/StarBase/StandardsAndGuidelines/">Standards and guidelines</a></li>
 <li>Create a pull request</li>
 <li>
-<p>Update StarDocs to document the impact of the change. You can use a link to the commit implementing the change as follows (<a href="https://github.com/ewowi/StarBase/commit/4f12da235bcee958b74f6d932b20a5ffcf9c449c">2024040511</a> is the version nr of the change):</p>
+<p>Update StarDocs to document and describe the impact of the change. You can use a link to the commit implementing the change as follows (<a href="https://github.com/ewowi/StarBase/commit/4f12da235bcee958b74f6d932b20a5ffcf9c449c">2024040511</a> is the version number of the change):</p>
 <p><img width="300" alt="image" src="https://github.com/ewowi/StarDocs/assets/138451817/31c591df-9241-49b6-aa71-1a7cd6282a89"></p>
 </li>
 <li>
-<p>In case of a StarBase change, propagate the change downstream to StarLeds. Git tree will typically look like (green is downstream, blue is upstream):</p>
+<p>In case of a StarBase change, propagate the change downstream to StarLeds. The git tree will typically look like this (green is downstream, blue is upstream):</p>
 <p><img width="300" alt="image" src="https://github.com/ewowi/StarDocs/assets/138451817/562978ff-1d97-4246-938f-501a19dfadec"></p>
 </li>
 <li>
-<p>Check if post merge steps are needed in StarLeds (e.g. rerun npm run dev to update html_ui.h)</p>
+<p>Determine if post merge steps are needed in StarLeds (e.g. rerun npm run dev to update html_ui.h)</p>
 </li>
 </ul>
 <p>🚧</p>

StarBase/GettingStarted/index.html

@@ -1936,7 +1936,7 @@ <h1>Getting started</h1>
 <h2 id="getting-started">Getting Started</h2>
 <ul>
 <li>
-<p>Download a firmware bin</p>
+<p>Download a firmware binary (bin)</p>
 <ul>
 <li><a href="https://github.com/ewowi/StarBase/releases">StarBase release</a> or <a href="https://github.com/MoonModules/StarLeds/releases">StarLeds release</a></li>
 <li><a href="https://github.com/ewowi/StarBase/actions">StarBase latest</a> or <a href="https://github.com/MoonModules/StarLeds/actions">StarLeds latest</a><ul>
@@ -1966,7 +1966,7 @@ <h2 id="getting-started">Getting Started</h2>
 </ul>
 <p><img width="293" alt="image" src="https://github.com/ewowi/StarDocs/assets/138451817/e7b1e16a-8014-42dc-9e07-f4e0cbf04efd"></p>
 <ul>
-<li>The Captive portal will show the setup tab, alternatively go to <a href="http://4.3.2.1">4.3.2.1</a></li>
+<li>The StarMod adaptive portal will show the setup tab, alternatively go to <a href="http://4.3.2.1">4.3.2.1</a></li>
 </ul>
 <p><img width="896" alt="image" src="https://github.com/ewowi/StarDocs/assets/138451817/cd8bd820-0a40-4ead-a0d2-14e0d0aa4ac3"></p>
 <ul>
@@ -1976,7 +1976,7 @@ <h2 id="getting-started">Getting Started</h2>
 </li>
 <li>Enter your Wifi credentials<ul>
 <li><a href="/StarDocs/SysMod/SysModNetwork">Network</a></li>
-<li>Note: first Save Model, then connect </li>
+<li>Note: first Save Model, then connect</li>
 </ul>
 </li>
 <li>Save Model<ul>
@@ -1985,8 +1985,8 @@ <h2 id="getting-started">Getting Started</h2>
 </li>
 <li>Reboot or press Connect</li>
 <li>Connect to the WiFi network</li>
-<li>Optionally choose a Theme</li>
-<li>Setup Application<ul>
+<li>Optionally, choose a display theme</li>
+<li>Setup the application<ul>
 <li>Continue here ! : <a href="/StarDocs/StarLeds/GettingStarted">Setup StarLeds</a></li>
 </ul>
 </li>

StarBase/StarLink/index.html

@@ -1934,35 +1934,47 @@
   <h1>StarLink</h1>
 
 <h2 id="starlink">StarLink</h2>
-<p>StarLink is the current name for the module that allows for multiple instances to be linked together (until we got sued).</p>
-<p>Its origin can be found in WLED-MoonModules and is called Super-Sync there, other names used are Mega-Sync, Ultra-Sync etc.</p>
-<p>In StarBase (and it's forks), StarLink is a distributed system meaning there is no sync master (there is in WLED) but instances are part of a group. A group is specified by an instance name identified by a hyphen: groupname-instancename.</p>
+<p>StarLink is the current name for the module that allows for multiple instances to be linked together (until we get sued).</p>
+<p>Its origin is Super-Sync, which can be found in WLED-MoonModules. Other names used are Mega-Sync, Ultra-Sync etc.</p>
+<p>StarLink is a distributed system meaning there is no sync master (there is in WLED). Instead, instances are part of a group. A group is specified by an instance name identified by a hyphen: groupname-instancename.</p>
 <p><img width="455" alt="Screenshot 2024-05-23 at 20 50 02" src="https://github.com/ewowi/StarDocs/assets/138451817/e3dbd019-6193-4081-aad1-63f178d396ac"></p>
 <p>The Link columns shows group info:</p>
 <ul>
 <li>0: There is no hyphen in the name, so this instance is not part of any group</li>
 <li>1: This instance has a group name but there are no other instances in the network with the same groupname</li>
-<li>2 or more: This instance is part of a group (the nr is the nr of instances in the group)</li>
+<li>2 or more: This instance is part of a group (the number is the number of instances in the group)</li>
 </ul>
-<p>Note that an instance in a group can be down, but as soon as the instance recovers, it will rejoin the group.</p>
+<p>Note that an instance in a group can be offline, but as soon as the instance recovers, it will rejoin the group.</p>
 <p>StarLink functionality is active if there are 2 or more instances in a group. This means that all dash variables (Variables which will show up in the dashboard 🚧) and it's children will be synchronized between all instances of the group. It doesn't matter in which instance of the group it will be changed, all other instances will be updated if it's changed.</p>
-<p>In the StarBase demoApp, On, Brightness and DMX channel are currently dash variables. In StarLeds, FX (and it's children/controls), projection (and it's children) are currently dash variables.</p>
+<p>In the StarBase demoApp: "On", "Brightness" and "DMX channel" are currently dash variables. In StarLeds, "FX" (and it's children/controls), "Projection" (and it's children) are currently dash variables.</p>
 <p>On a group of sticks this looks as follows:</p>
 <video width="650" autoplay><source src="https://github.com/ewowi/StarDocs/assets/138451817/36d8a25d-c3cb-40d1-953a-330e06db9983" type="video/mp4"></video>
 
 <p>(In this video, there are 2 RGBW sticks which behave a bit differently)</p>
 <h2 id="_1">🚧</h2>
 <p>Above is the current state of StarMod/StarLeds.</p>
-<p>Below is the work in progress:</p>
+<p>Below are the works in progress:</p>
 <ul>
 <li>IP, mac-address, name: Mac-address will be the id to store info of other instances in an instance (unchangeable), IP is used to access an instance (can change), instance name is the user friendly name of an instance (and used for grouping)</li>
 <li>Position: Each instance will have a position which is used to order instances</li>
 <li>Synchronized Time: Each instance will have the same time in milliseconds, will have the same random seed and therefore in StarLeds, effects will run exactly the same.</li>
-<li>StarLeds - Distributed effect: using ordered instances, multiple instances can each run part of an effect - scalibility, depending on the effect:<ul>
-<li>Only the displayed part can be rendered. also random seeds helps here</li>
+<li>StarLeds - Distributed effects: Using ordered instances, multiple instances can each run part of an effect. This can facilitate scalibility, depending on how the effect is implemented. Each approach has different benefits in terms of performance and simplicity:<ul>
+<li>
+<ol>
+<li>Render only the displayed part. It can be beneficial to use a random seed here.</li>
+</ol>
+</li>
+<li>
+<ol>
 <li>Displayed part plus a bit needs to be rendered</li>
-<li>The whole effect must be rendered.</li>
-<li>Note: rendering the effect without showing it on leds is much faster, eg game of life about 10 times faster</li>
+</ol>
+</li>
+<li>
+<ol>
+<li>Render the entire effect, including parts that are not displayed by each instance. This can be simple, but can experience scalability barriers.</li>
+</ol>
+</li>
+<li>Note: Rendering the effect without showing it on leds is much faster, eg game of life about 10 times faster. This is because writing the data out to LEDs requires specific timing.</li>
 </ul>
 </li>
 </ul>

StarBase/Testing/index.html

@@ -1934,28 +1934,28 @@
   <h1>Testing</h1>
 
 <h2 id="testing-starbase">Testing StarBase</h2>
-<p><a href="/StarDocs">StarBase</a> is in user test phase. Test scenarios are currently developed. See below for current available test scenarios. If you want to participate in testing:</p>
+<p><a href="/StarDocs">StarBase</a> is in user test phase. Test scenarios are currently available. If you want to participate in testing, please see below for currently available test scenarios:</p>
 <ul>
 <li>Follow a test scenario</li>
 <li>Please report issues in <a href="https://github.com/ewowi/StarBase/issues">Github StarBase issues</a> or <a href="https://github.com/MoonModules/StarLeds/issues">Github StarLeds issues</a><ul>
 <li>Include the build you are testing (see <a href="/StarDocs/SysMod/SysModSystem">System</a>)</li>
 <li>Include the test scenario</li>
 </ul>
 </li>
-<li>You can report success also in Github issues or on <a href="https://discord.gg/VGDGGX8qvQ">Discord / StarMod</a> and include things not clear, suggestions for improvement, new test scenarios etc.</li>
+<li>You can report success also in Github issues or on <a href="https://discord.gg/VGDGGX8qvQ">Discord / StarMod</a>. Please include information explaining whether the instructions were clear, suggestions for improvement to documentation or procedure, or share opportunities new test scenarios, etc.</li>
 <li>Improve this documentation by forking <a href="https://github.com/ewowi/StarDocs">StarDocs</a>, edit and submit a pull request</li>
 <li>Any feedback big or small is welcome</li>
 <li>See <a href="https://github.com/ewowi/StarDocs/files/14837446/Starmod.pdf">StarBase 💫.pdf</a> for the story of StarBase in bullet points</li>
 </ul>
 <h2 id="current-test-scenarios">Current test scenarios</h2>
 <ul>
 <li><a href="/StarDocs/StarBase/GettingStarted/">Getting Started</a><ul>
-<li>Follow the instructions until StarLeds is up and running</li>
-<li>Optionally add a led panel or ring to a gpio port of the esp32 and check leds are burning</li>
+<li>Follow the instructions to get StarLeds up and running</li>
+<li>Optionally, add a LED panel or ring to a gpio port of the ESP32 and check to confirm that LEDs are burning</li>
 </ul>
 </li>
 <li><a href="/StarDocs/SysMod/SysModSystem/">OTA Update</a><ul>
-<li>Download a firmware bin, see <a href="/StarDocs/StarBase/GettingStarted/">Getting Started</a></li>
+<li>Download a firmware binary (bin), see <a href="/StarDocs/StarBase/GettingStarted/">Getting Started</a></li>
 <li>in the <a href="/StarDocs/SysMod/SysModSystem">System module</a>:<ul>
 <li>Check the currently installed build (Since April 14)</li>
 <li>Upload a bin corresponding with the installed build / board using OTA update</li>

StarBase/news/index.html

@@ -1968,12 +1968,12 @@ <h3 id="april-17-2024-new-test-scenario-ota-update">April 17, 2024: New test sce
 <p>see <a href="https://ewowi.github.io/StarDocs/StarBase/Testing/">StarBase Testing</a></p>
 <p><img width="400" alt="Screenshot 2024-04-17 at 10 52 13" src="https://github.com/ewowi/StarDocs/assets/138451817/fc72063e-20b5-4f55-ba13-cbe80b889b0b"></p>
 <ul>
-<li>Testers wanted to test OTA update, and also Getting Started </li>
-<li>Can be tested on StarBase or StarLeds, StarLeds is the most feature rich test</li>
-<li>Release 0.0.0 has been added in github repos of StarBase and StarLeds you can download bins there</li>
+<li>Testers are wanted to test OTA updates, and to follow the Getting Started and deliver feedback.</li>
+<li>Tests can be performed on StarBase or StarLeds. StarLeds is the most feature rich test.</li>
+<li>Release 0.0.0 has been added in GitHub repos of StarBase and StarLeds. You can download bins there.</li>
 <li>Different target boards supported, esp32, esp32s3, esp32s2, esp32c3, pico32</li>
-<li>Some work has been done on documentation in StarDocs but still far from complete and sometimes in telegram style. Improving the docs by forking and submitting pull requests is highly appreciated :wink:</li>
-<li>Check also the <a href="https://ewowi.github.io/StarDocs/StarBase/Contribute/">contribute page</a></li>
+<li>Some work has been done on StarDocs documentation but still far from complete and sometimes described in a terse style. Improving the docs by forking and submitting pull requests is highly appreciated :wink:</li>
+<li>Please also review the <a href="https://ewowi.github.io/StarDocs/StarBase/Contribute/">contribute page</a> for more ways to help advance the project</li>
 </ul>
 <h3 id="april-6-2024-starmod-starbase-and-starleds-repositories">April 6, 2024: StarMod -&gt; StarBase and StarLeds repositories</h3>
 <p>The LEDs part of <a href="https://github.com/ewowi/StarBase">ewowi/StarBase</a> has been moved to <a href="https://github.com/MoonModules/StarLeds">MoonModules/StarLeds</a>. From now on:</p>

StarLeds/GettingStarted/index.html

@@ -1924,7 +1924,7 @@ <h2 id="getting-started">Getting Started</h2>
 </ul>
 </li>
 <li>
-<p>Select the Leds tab in the UI</p>
+<p>Select the LEDs tab in the UI</p>
 </li>
 <li>
 <p>Generate a fixture</p>
@@ -1938,7 +1938,7 @@ <h2 id="getting-started">Getting Started</h2>
 <p><img width="365" alt="image" src="https://github.com/ewowi/StarDocs/assets/138451817/67a4ae2c-1ad9-4e30-88a9-f70f6187f613"></p>
 <ul>
 <li>
-<p>Connect leds to the ESP32 GPIO pins as defined in the F_ixture.json file</p>
+<p>Connect LEDs to the ESP32 GPIO pins as defined in the F_ixture.json file</p>
 </li>
 <li>
 <p>A generated fixture will be selected automatically in the Fixture Module</p>

StarLeds/Overview/index.html

@@ -1959,9 +1959,9 @@ <h1>Overview</h1>
 <p><img width="390" alt="image" src="https://github.com/ewowi/StarDocs/assets/138451817/59dc199c-6697-43f4-9a1b-f8413005aa5f"></p>
 <h2 id="starleds-overview">StarLeds overview</h2>
 <p>The Leds modules of StarBase define a fixture (<a href="https://ewowi.github.io/StarDocs/LedMod/LedModFixture%20Generator/">Fixture generator module</a>), Set Effects and projections (<a href="https://ewowi.github.io/StarDocs/LedMod/LedModEffects/">Effects module</a>) and displays it (<a href="https://ewowi.github.io/StarDocs/LedMod/LedModFixture/">Fixture module</a>).</p>
-<p>All Modulus support 1D, 2D and 3D effects and fixtures and all combinations of it. Effects are unaware of the fixtures it is displayed on (e.g. a 1D effect can be projected on a 3D fixture or a 3D effect on a 1D fixture (strip))</p>
+<p>All Modules support 1D, 2D and 3D effects and fixtures and all combinations of it. Effects are unaware of the fixtures it is displayed on (e.g. a 1D effect can be projected on a 3D fixture or a 3D effect on a 1D fixture (strip))</p>
 <h2 id="mappings">Mappings</h2>
-<p>In the world of Led software mapping is a word causing lots of discussion and confusion. StarLeds is designed to make it simpler and more flexible, by having a clear separation of physical and logical and a clear distinction of fixtures, effects and projections (see <a href="https://ewowi.github.io/StarDocs/StarBase/StandardsAndGuidelines/">Orthogonality</a>). Below is an attempt to explain it. Feel free to improve the text / add pictures (fork and PR).</p>
+<p>In the world of LED software mapping is a word causing lots of discussion and confusion. StarLeds is designed to make it simpler and more flexible, by having a clear separation of physical and logical and a clear distinction of fixtures, effects and projections (see <a href="https://ewowi.github.io/StarDocs/StarBase/StandardsAndGuidelines/">Orthogonality</a>). Below is an attempt to explain it. Feel free to improve the text / add pictures (fork and PR).</p>
 <ul>
 <li>F_ixture.json contains a definition of the fixture. It specifies the name, nrOfLeds and the width, height and depth of the fixture in cm. Note that nrOfLeds is not equal to the product of width, height and depth as in a lot of fixtures there is not a pixel on every cm. Panels and strips do have a pixel on each cm but rings or hexagons or wheels etc not. Furthermore it specifies for each pin (or ip addres - WIP) the physical coordinate of the pixels (in mm as circular fixtures requires mm accuracy !!) which are connected to the pin, in order of pixels connected in the daisy chain.</li>
 <li>An effect specifies in a virtual width, height and depth what the effect does. It uses a FASTLED compatible syntax including leds[i] assignments. Also setPixelColor and getPixelColor can be used. Effect can be 1D, 2D or 3D.</li>

StarLeds/Sound/index.html

@@ -1934,7 +1934,7 @@
   <h1>Sound</h1>
 
 <h2 id="starleds-sound-design">Starleds sound - Design</h2>
-<p>This is VERY much 🚧</p>
+<p>This is VERY much in progress 🚧</p>
 <ul>
 <li>7 bands, same frequencies as MSGEQ7 (but only if no visual difference in 16 band smooth mode)</li>
 <li>7 knobs to tune each band</li>