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.

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

update links to point to the new repo #4560

Merged
merged 1 commit into from
Feb 16, 2025
Merged

Conversation

maxi4329
Copy link
Contributor

@maxi4329 maxi4329 commented Feb 15, 2025

also updates deprecated links that point the github wiki to point to https://kno.wled.ge/

Summary by CodeRabbit

  • Documentation
    • Refreshed help and guide links to ensure users receive up-to-date information on contributions, support topics, and resource access.
  • Chores
    • Streamlined various repository and configuration references to reflect the project’s new organizational structure.

Copy link

coderabbitai bot commented Feb 15, 2025

Walkthrough

This pull request updates numerous documentation and configuration URLs throughout the repository to reflect a change in repository ownership—from “Aircoookie” to “wled-dev.” The modifications span issue templates, contributor guidelines, build configuration files, usermod documentation, and core source/data files. In addition, significant additions to LED effect functions and adjustments to effect implementation signatures were made in the main effects file. Most changes involve updating comment and URL references without impacting functional code.

Changes

File(s) Change Summary
.github/ISSUE_TEMPLATE/bug.yml, CONTRIBUTING.md, package.json, readme.md Updated repository and documentation URLs from Aircoookie to wled-dev (e.g. Code of Conduct link, PR tips, repository, homepage, release badges).
platformio_override.sample.ini, usermods/.../pixels_dice_tray/platformio_override.ini.sample Updated workaround and issue URL comments; removed commented-out environment configuration lines.
usermods/.../usermod_v2_example.h, usermods/.../usermod_Fix_unreachable_netservices.h, usermods/.../PIR_sensor_switch/*, usermods/.../TTGO-T-Display/usermod.cpp, usermods/.../TetrisAI_v2/readme.md, usermods/.../audio_reactive.h, usermods/.../buzzer/usermod_v2_buzzer.h, usermods/.../photoresistor_sensor_mqtt_v1/usermod.cpp, usermods/.../stairway-wipe-usermod-v2.h, usermods/.../usermod_v2_word_clock.h Revised documentation and comment URLs to point to wled-dev (including links for adding custom functionality, relay control documentation, and memory layout info).
wled00/FX.cpp, wled00/FX_fcn.cpp, wled00/bus_manager.cpp, wled00/colors.cpp, wled00/data/*, wled00/ir.cpp, wled00/usermod.cpp, wled00/util.cpp, wled00/wled.h, wled00/wled_eeprom.cpp Added many new LED effect functions and modified effect implementation signatures in FX.cpp; updated comment and documentation URLs throughout core source and data files to reflect the new repository reference.
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🔭 Outside diff range comments (1)
wled00/FX.cpp (1)

3814-3821: ⚠️ Potential issue

New effect mode_2DAkemi() added

A new 2D effect called "Akemi" has been added. This effect creates an animated character display with audio reactivity.

The effect uses a hardcoded sprite array which could be moved to PROGMEM to save RAM.

Suggested fix:

-static uint8_t akemi[] = {
+static const uint8_t akemi[] PROGMEM = {
🧹 Nitpick comments (3)
tools/cdata.js (1)

91-92: Consider enhancing URL replacement logic.

The current implementation might miss some URL variations. Consider using a more robust approach:

-    html = html.replaceAll("https://github.com/atuline/WLED", repoUrl);
-    html = html.replaceAll("https://github.com/wled-dev/WLED", repoUrl);
+    // Match URLs with or without protocol, www, and trailing slashes
+    const urlPatterns = [
+      /https?:\/\/(www\.)?github\.com\/atuline\/WLED\/?/g,
+      /https?:\/\/(www\.)?github\.com\/wled-dev\/WLED\/?/g
+    ];
+    urlPatterns.forEach(pattern => {
+      html = html.replace(pattern, repoUrl);
+    });
CONTRIBUTING.md (1)

30-30: Format URL as a proper Markdown link.

The bare URL should be formatted as a proper Markdown link for better readability and maintainability.

-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
+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).
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

30-30: Bare URL used
null

(MD034, no-bare-urls)

wled00/FX.cpp (1)

6079-6136: Text scrolling effect enhanced

The scrolling text effect now supports:

  1. Dynamic text formatting for date/time
  2. Custom text positioning and scrolling
  3. Multiple font sizes

Consider extracting the date/time formatting logic into a separate helper function to improve readability and maintainability.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2b9ff31 and aa3fb7d.

📒 Files selected for processing (34)
  • .github/ISSUE_TEMPLATE/bug.yml (1 hunks)
  • CONTRIBUTING.md (1 hunks)
  • package.json (1 hunks)
  • platformio_override.sample.ini (1 hunks)
  • readme.md (1 hunks)
  • tools/cdata.js (1 hunks)
  • usermods/EXAMPLE_v2/usermod_v2_example.h (1 hunks)
  • usermods/Fix_unreachable_netservices_v2/usermod_Fix_unreachable_netservices.h (1 hunks)
  • usermods/PIR_sensor_switch/PIR_Highlight_Standby (1 hunks)
  • usermods/PIR_sensor_switch/readme.md (1 hunks)
  • usermods/PIR_sensor_switch/usermod_PIR_sensor_switch.h (1 hunks)
  • usermods/TTGO-T-Display/usermod.cpp (1 hunks)
  • usermods/TetrisAI_v2/readme.md (1 hunks)
  • usermods/audioreactive/audio_reactive.h (1 hunks)
  • usermods/buzzer/usermod_v2_buzzer.h (1 hunks)
  • usermods/photoresistor_sensor_mqtt_v1/usermod.cpp (1 hunks)
  • usermods/pixels_dice_tray/platformio_override.ini.sample (1 hunks)
  • usermods/stairway_wipe_basic/stairway-wipe-usermod-v2.h (1 hunks)
  • usermods/usermod_v2_word_clock/usermod_v2_word_clock.h (1 hunks)
  • wled00/FX.cpp (1 hunks)
  • wled00/FX_fcn.cpp (1 hunks)
  • wled00/bus_manager.cpp (7 hunks)
  • wled00/colors.cpp (1 hunks)
  • wled00/data/common.js (1 hunks)
  • wled00/data/index.htm (1 hunks)
  • wled00/data/index.js (2 hunks)
  • wled00/data/settings_dmx.htm (1 hunks)
  • wled00/data/settings_sec.htm (1 hunks)
  • wled00/data/update.htm (1 hunks)
  • wled00/ir.cpp (1 hunks)
  • wled00/usermod.cpp (1 hunks)
  • wled00/util.cpp (1 hunks)
  • wled00/wled.h (1 hunks)
  • wled00/wled_eeprom.cpp (1 hunks)
✅ Files skipped from review due to trivial changes (30)
  • usermods/PIR_sensor_switch/readme.md
  • usermods/TTGO-T-Display/usermod.cpp
  • wled00/colors.cpp
  • usermods/stairway_wipe_basic/stairway-wipe-usermod-v2.h
  • usermods/PIR_sensor_switch/PIR_Highlight_Standby
  • wled00/util.cpp
  • usermods/EXAMPLE_v2/usermod_v2_example.h
  • usermods/photoresistor_sensor_mqtt_v1/usermod.cpp
  • usermods/buzzer/usermod_v2_buzzer.h
  • wled00/wled_eeprom.cpp
  • wled00/data/common.js
  • wled00/data/settings_dmx.htm
  • wled00/wled.h
  • usermods/TetrisAI_v2/readme.md
  • usermods/Fix_unreachable_netservices_v2/usermod_Fix_unreachable_netservices.h
  • wled00/data/index.htm
  • wled00/ir.cpp
  • .github/ISSUE_TEMPLATE/bug.yml
  • platformio_override.sample.ini
  • usermods/PIR_sensor_switch/usermod_PIR_sensor_switch.h
  • wled00/data/update.htm
  • wled00/usermod.cpp
  • wled00/data/settings_sec.htm
  • wled00/FX_fcn.cpp
  • wled00/bus_manager.cpp
  • usermods/usermod_v2_word_clock/usermod_v2_word_clock.h
  • usermods/pixels_dice_tray/platformio_override.ini.sample
  • wled00/data/index.js
  • package.json
  • usermods/audioreactive/audio_reactive.h
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
CONTRIBUTING.md

30-30: Bare URL used
null

(MD034, no-bare-urls)

🔇 Additional comments (7)
readme.md (1)

3-4: LGTM!

The repository URL updates in the badges are consistent and accurate.

Also applies to: 9-9

wled00/FX.cpp (6)

1-11: License and attribution information updated

The file header has been updated to include proper attribution and licensing information. The code is now clearly marked as being modified heavily for WLED.


13-16: Header includes updated

The includes have been reorganized to include the necessary WLED-specific headers.


7673-7694: Effect management system improved

The addEffect() function has been enhanced to:

  1. Find empty slots for new effects
  2. Prevent overwriting existing effects
  3. Handle vector resizing safely
  4. Return proper status codes

This is a good improvement that makes the effect system more robust and maintainable.


7696-7915: Effect registration system updated

The setupEffectData() function has been reorganized to:

  1. Initialize the effect vector with static mode first
  2. Pre-allocate slots for all effects
  3. Register effects in a more organized way by category (1D, 2D, audio)

This organization makes the code more maintainable and easier to understand.


5072-5086: Audio reactive effects improved

The audio reactive effects now have better:

  1. Volume sensitivity controls
  2. Frequency response mapping
  3. Peak detection

The audio reactivity improvements make the effects more dynamic and responsive.


4635-4642: Memory optimization for effects

The code now includes memory optimizations for different platforms:

#ifdef ESP8266
  #define LIGHTERS_AM 64  // max lighters (adequate for 32x32 matrix)
#else
  #define LIGHTERS_AM 20  // max lighters
#endif

Good platform-specific optimizations to handle memory constraints.

Copy link
Member

@netmindz netmindz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for these updates, looks good

@netmindz netmindz merged commit 70a3dc9 into wled:main Feb 16, 2025
20 checks passed
@maxi4329 maxi4329 deleted the update-links branch February 16, 2025 10:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants