Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Setup https://moonmodules.github.io/WLED-Docs/ #6

Closed
ewoudwijma opened this issue Nov 28, 2022 · 6 comments
Closed

Setup https://moonmodules.github.io/WLED-Docs/ #6

ewoudwijma opened this issue Nov 28, 2022 · 6 comments
Labels
enhancement New feature or request

Comments

@ewoudwijma
Copy link
Collaborator

Created this issue to discuss how we should setup MoonModules documentation using https://moonmodules.github.io/WLED-Docs/

This is a fork of https://kno.wled.ge and is in initial setup.

  • perfect symbiose of upstream info + fork info IMO.
  • supported by GitHub workflows so any commit towards it will automatically update the pages.

See also atuline#235
@ewoudwijma ewoudwijma added the enhancement New feature or request label Nov 28, 2022
@ewoudwijma
Copy link
Collaborator Author

ewoudwijma commented Nov 28, 2022 •
edited
Loading

Current guidelines

  • Welcome contains an extra paragraph on top called Welcome to WLED MoonModules, rest of the page is a 1:1 copy of upstream
  • Basics, Features, Interfaces, Advanced, About is a 1:1 copy of upstream
  • Added MoonModules, 2D and Sound Reactive
  • MoonModules: features in WLEDMM not (yet) in upstream (except 2D and SR)
  • 2D: 2D info
  • Sound Reactive: SR info
  • Some pages have been copy pasted from WLEDSR wiki, unmodified (e.g. Fork Comparison, 2D settings, SR settings, Digital Microphone Hookup), they need to be changed
  • Every pages may contain a section at the bottom called Fork specific info (or similar) where differences compared to MM are described
  • If a page has been moved from WLED SR Wiki to here, this WLED SR page can link to this.

Any comments?
What should be the menu structure/items? I know copied some of the wiki page titles of WLED SR, or should we introduce other page titles?

@ewoudwijma ewoudwijma mentioned this issue Nov 28, 2022
Open
@dosipod
Copy link

dosipod commented Dec 12, 2022

Looks okay ,just small comments , I do not think normal users will be interested to use MM much so you can skip the basic info that is already in the wled KB and focus on the more advanced functions . Also as an example I can not find reference to jmap in search

@ewoudwijma
Copy link
Collaborator Author

ewoudwijma commented Dec 13, 2022 •
edited
Loading

skip the basic info that is already in the wled KB

  • This is just a GitHub repo and a fork of kno.wled.ge so we get this info by default and will kept up to date if synced with upstream
  • Unless decided otherwise, this work will not edit existing WLED AC pages but only add in the new Tabs
  • The big advantage of this being a fork we have all info in one place

as an example I can not find reference to jmap in search

@ewoudwijma
Copy link
Collaborator Author

ewoudwijma commented Dec 13, 2022 •
edited
Loading

To make the next step in improving this repo, I made a 1:1 copy of everything what is on the WLEDSR / Wiki page (and removed stuff from the 2D and Sound Reactive tabs).

image

As a 'test' I added info similar as in WLED AC wiki on some of the current WLED SR Wiki pages as follows:

image

I am not sure yet what to do with this. Should I add this to all pages?
@softhack007 what do you think as you are the main editor, what are the next steps for the WLEDSR wiki?

For https://moonmodules.github.io/WLED-Docs/ I think the way forward is:

  • Ask aircoookie how he plans to add 2D and SR info in kno.wled.ge (where in the menu hierarchy)
  • Depending on his answer create the pages on the right page, if not sure yet we use the 2D and SR tabs to slowly migrate the content in WLEDSR to the 0.14 definitions
  • We submit pull request on new 2D/SR documentation to upstream

@softhack007
Copy link
Collaborator

softhack007 commented Dec 13, 2022 •
edited
Loading

I am not sure yet what to do with this. Should I add this to all pages?
@softhack007 what do you think as you are the main editor, what are the next steps for the WLEDSR wiki?

Hi, currently I don't update the SR Wiki so often, but a few times already added some details after we had discussion on discord or on gh bugreports.

I think we should keep the wiki pages where they are, and add something like you suggested - like "latest/updated info is available in wled-docs". Because some people learned how to find the wiki. Only problem was you cannot search it on google.

Seems I need to learn the new system ;-) Generally its ok for me to make new edits in wled-docs only.

Another small thing - we need to adjust the "help" links in SRWLED to point to the new locations.

@ewoudwijma
Copy link
Collaborator Author

ewoudwijma commented Dec 13, 2022 •
edited
Loading

Indeed maybe better 'leave it as is' and also keep the links in the app the same. Think it is better after some more thoughts. I removed the links from WLEDSR to WLEDMM Docs

Maybe our update procedure can be driven by questions on discord or on just what we think needs to be done:

  1. question requires update / clarification in documentation
  2. if SR impact then update WLEDSR/Wiki documentation
  3. if 0.14 / MM impact then migrate info in WLEDMM/Docs from WLEDSR tab to the right place, so we slowly build our new documentation (MM specific to MoonModules tab and 0.14 general to 2D/SoundReactive tab)

softhack007 added a commit that referenced this issue Nov 15, 2023
@softhack007
bugfix for random crash when switching between presets
188956a 
this is a band-aid fix for random crashes when switching between presets with multiple segments - crossfade disabled.

!! adding type initializers fixed it for me on -S3, however I still see (less frequent) crashes on esp32, due to heap corruption.

It took me hours to get a meaningful stackdump:

assert failed: heap_caps_free heap_caps.c:360 (heap != NULL && "free() target pointer is outside heap areas")

Backtrace: 0x40084ee1:0x3ffb2570 0x4008e341:0x3ffb2590 0x40094709:0x3ffb25b0 0x4008534a:0x3ffb26e0 0x40094739:0x3ffb2700 0x400e9037:0x3ffb2720 0x400e917c:0x3ffb2740 0x400eaeeb:0x3ffb2760 0x40117ec5:0x3ffb27c0 0x401184ea:0x3ffb2800 0x4013509d:0x3ffb2820

  #0  0x40084ee1:0x3ffb2570 in panic_abort at /Users/ficeto/Desktop/ESP32/ESP32S2/esp-idf-public/components/esp_system/panic.c:402
  #1  0x4008e341:0x3ffb2590 in esp_system_abort at /Users/ficeto/Desktop/ESP32/ESP32S2/esp-idf-public/components/esp_system/esp_system.c:128
  #2  0x40094709:0x3ffb25b0 in __assert_func at /Users/ficeto/Desktop/ESP32/ESP32S2/esp-idf-public/components/newlib/assert.c:85
  #3  0x4008534a:0x3ffb26e0 in heap_caps_free at /Users/ficeto/Desktop/ESP32/ESP32S2/esp-idf-public/components/heap/heap_caps.c:360
      (inlined by) heap_caps_free at /Users/ficeto/Desktop/ESP32/ESP32S2/esp-idf-public/components/heap/heap_caps.c:345
  #4  0x40094739:0x3ffb2700 in free at /Users/ficeto/Desktop/ESP32/ESP32S2/esp-idf-public/components/newlib/heap.c:39
  #5  0x400e9037:0x3ffb2720 in Segment::deallocateData() at wled00/FX_fcn.cpp:189
  #6  0x400e917c:0x3ffb2740 in Segment::resetIfRequired() at wled00/FX_fcn.cpp:206
      (inlined by) Segment::resetIfRequired() at wled00/FX_fcn.cpp:203
  #7  0x400eaeeb:0x3ffb2760 in WS2812FX::service() at wled00/FX_fcn.cpp:1216 (discriminator 2)
  #8  0x40117ec5:0x3ffb27c0 in WLED::loop() at wled00/wled.cpp:115 (discriminator 3)
  #9  0x401184ea:0x3ffb2800 in loop() at C:/src/wled00/wled00.ino:20
  #10 0x4013509d:0x3ffb2820 in loopTask(void*) at C:/Users/user/.platformio/packages/framework-arduinoespressif32/cores/esp32/main.cpp:50

ELF file SHA256: 18c20b536f4c6ef4
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@ewoudwijma @dosipod @MoonModules @softhack007