You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/develop/development.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,11 +37,11 @@ npm run dev
37
37
38
38
There are 3 levels to add functionality:
39
39
40
-
***Standard ESP32-Sveltekit code**, e.g. Connections, Wifi and System. MoonBase files is also made using standard sveltekit as example but contains a few components used in MoonLight modules. Might be rewriteen as MoonLight Module in the future.
41
-
* lib folder for Sveltekit vack-end
40
+
***Standard ESP32-Sveltekit code**, e.g. Connections, Wifi and System. MoonBase files are also made using standard SvelteKit as examples but contain a few components used in MoonLight modules. Might be rewritten as a MoonLight Module in the future.
41
+
* lib folder for Sveltekit back-end
42
42
* Read the [ESP32 Sveltekit docs](https://moonmodules.org/MoonLight/esp32sveltekit/)
43
43
*[MoonLight Modules](https://moonmodules.org/MoonLight/moonbase/modules/) e.g. Lights Control, Effects, Info, Channels. They are subclasses of Modules.h/cpp and implement setupDefinition, onUpdate and optional loop. New modules need to be defined in main.cpp and added to menu.svelte. All further UI is generated by Module.svelte.
44
-
* src folder for MoonBase and MoonLight vack-end
44
+
* src folder for MoonBase and MoonLight back-end
45
45
***MoonLight Nodes**: the easiest and recommended way. See Effects.h, Layouts.h, Modifiers.h and Drivers.h for examples. They match closest WLED usermods. Each node has controls, a setup and a loop and can be switched on and off. For specific purposes hasOnLayout() and hasModifier() can return true.
46
46
* src/MoonLight/nodes
47
47
@@ -67,7 +67,7 @@ See [Documentation](https://moonmodules.org/MoonLight/develop/documentation/)
67
67
68
68
* The upstream MoonLight repo can now process this PR
69
69
70
-
## Addtional info
70
+
## Additional info
71
71
72
72
### Emoji coding
73
73
@@ -88,9 +88,9 @@ See [Documentation](https://moonmodules.org/MoonLight/develop/documentation/)
88
88
89
89
### UI development server
90
90
91
-
To ease the frontend development you can deploy the vack-end code on an ESP32 board and pass the websocket and REST API calls through the development server's proxy running on your computer.
91
+
To ease the front-end development you can deploy the back-end code on an ESP32 board and pass the websocket and REST API calls through the development server's proxy running on your computer.
92
92
93
-
This very much speeds up UI development as no flashing to ESP32 is required to test updated UI. Svaing an UI file is enough to see the results!!!
93
+
This very much speeds up UI development, as no flashing to the ESP32 is required to test updated UI. Saving a UI file is enough to see the results.
94
94
95
95
See [Setup Proxy for Development](https://moonmodules.org/MoonLight/gettingstarted/#setup-proxy-for-development) and [development-server](https://moonmodules.org/MoonLight/gettingstarted/#development-server) how to setup.
Copy file name to clipboardExpand all lines: docs/develop/standardsguidelines.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@
9
9
* The main branch is the source to branch and merge to, no direct code commits to the main branch. As the main branch docs folder is the source for the website, doc changes can be made directly to main.
10
10
* Branches from main are made for latest updates and merged back to main when done.
11
11
* The src folder is for all MoonBase and MoonLight Nodes and Modules development. No need for UI changes as that is generated for Nodes and Modules. The lib folder is for upstream (Sveltekit). The interface folder is for UI, mainly Sveltekit and Modules and Nodes generic functions.
12
-
* A pull request should contain compilable code and tested tonot crash the system at minimal and support also boards without PSRAM, e.g. ESP32-D0. Code may be work in progress.
12
+
* A pull request should contain compilable code that is tested to, at minimum, not crash the system and also supports boards without PSRAM, e.g. ESP32-D0. Code may be work in progress.
13
13
14
14
## Describe your PR
15
15
@@ -35,7 +35,7 @@ Github will pick up the changes so your PR stays up-to-date.
35
35
36
36
> [!CAUTION]
37
37
> Do not use "force-push" while your PR is open!
38
-
> It has many subtle and unexpected consequences on our github repository.
38
+
> It has many subtle and unexpected consequences on our GitHub repository.
39
39
> For example, we regularly lost review comments when the PR author force-pushes code changes. So, pretty please, do not force-push.
40
40
41
41
You can find a collection of very useful tips and tricks here: https://github.com/wled-dev/WLED/wiki/How-to-properly-submit-a-PR
@@ -52,10 +52,10 @@ You can find a collection of very useful tips and tricks here: https://github.co
52
52
* If you don't feel very confident using English, you can use AI for translating code comments and descriptions into English. AI bots are very good at understanding language. However, always check if the results is correct. The translation might still have wrong technical terms, or errors in some details.
53
53
54
54
### best practice with AI:
55
-
* As the person who contributes source code to MoonLight, make sure you understand exactly what the AIgenerated code does
56
-
* best practice: add a comment like ``'// below section of my code was generated by an AI``, when larger parts of your source code were not written by you personally.
55
+
* As the person who contributes source code to MoonLight, make sure you understand exactly what the AI-generated code does
56
+
@@ * best practice: add a comment like ``'// below section of my code was generated by an AI``, when larger parts of your source code were not written by you personally.
57
57
* always review translations and code comments for correctness
58
-
* always review AIgenerated source code
58
+
* always review AI-generated source code
59
59
* If the AI has rewritten existing code, check that the change is necessary and that nothing has been lost or broken. Also check that previous code comments are still intact.
60
60
61
61
## Code style
@@ -64,7 +64,7 @@ You can find a collection of very useful tips and tricks here: https://github.co
64
64
65
65
We use Clang-format for c-files (see .clang-format in the repo for the definition) and Prettier for front-end files.
66
66
67
-
Rightclick Format Document on each file you edit before committing.
67
+
Right-click Format Document on each file you edit before committing.
0 commit comments