-
-
Notifications
You must be signed in to change notification settings - Fork 2k
Update mipi_dsi.md #5277
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
base: current
Are you sure you want to change the base?
Update mipi_dsi.md #5277
Conversation
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughReplaced the minimal configuration example to reference board Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. 📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 💡 Knowledge Base configuration:
You can enable these sources in your CodeRabbit configuration. 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🧹 Nitpick comments (1)
content/components/display/mipi_dsi.md (1)
46-46
: Switch to a canonical, non-locale URL and drop tracking parametersThe current link targets a locale-specific Aliexpress domain and includes tracking query params. Prefer a stable, canonical URL to reduce link rot and avoid geo/language redirects.
If there’s a specific product page, link to it directly; otherwise use a generic, non-locale search URL.
Proposed change:
-| JC4880P443C | Guition | <https://fr.aliexpress.com/w/wholesale-JC4880P443C.html?spm=a2g0o.detail.history.1.489aFH3VFH3V3k> | +| JC4880P443C | Guition | <https://www.aliexpress.com/w/wholesale-JC4880P443C.html> |Also, please confirm:
- The board/model identifier “JC4880P443C” exactly matches the identifier used in esphome core.
- Support for this model is already released; otherwise, this doc should target the next branch with a link to the enabling core PR.
Would you add the core PR/commit link in the PR description for traceability?
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
content/components/display/mipi_dsi.md
(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**
⚙️ CodeRabbit configuration file
- Do not generate or add any sequence diagrams
Files:
content/components/display/mipi_dsi.md
🪛 GitHub Check: build
content/components/display/mipi_dsi.md
[failure] 51-51:
Multiple consecutive blank lines [Expected: 1; Actual: 2]
🪛 GitHub Actions: Lint
content/components/display/mipi_dsi.md
[error] 51-51: markdownlint MD012/no-multiple-blanks: Multiple consecutive blank lines (Expected: 1; Actual: 2) in content/components/display/mipi_dsi.md at line 51.
There was a problem hiding this 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
♻️ Duplicate comments (1)
content/components/display/mipi_dsi.md (1)
51-51
: Fix markdownlint MD012: remove the extra blank line before “## Configuration”This extra blank line fails the docs lint job. Remove it so there’s only a single blank line between the table and the heading.
Apply this change:
-
🧹 Nitpick comments (1)
content/components/display/mipi_dsi.md (1)
46-46
: Use a stable product URL instead of a search results linkThe AliExpress "wholesale" search URL is volatile and can break or change over time. For consistency with the row above (which uses a stable item URL) and to reduce link rot, please replace it with a direct product page or the manufacturer’s canonical page.
Proposed template diff (replace REPLACE_WITH_ITEM_ID with the actual item id or swap in a stable vendor URL):
-| JC4880P443C | Guition | <https://aliexpress.com/w/wholesale-JC4880P443C.html> | +| JC4880P443C | Guition | <https://aliexpress.com/item/REPLACE_WITH_ITEM_ID.html> |Additionally, please verify that this board model is actually supported by the component (i.e., has a corresponding
model:
value in ESPHome) to avoid documenting a non-existent option. If there is a matching esphome PR or commit, link it in the PR description.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
content/components/display/mipi_dsi.md
(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**
⚙️ CodeRabbit configuration file
- Do not generate or add any sequence diagrams
Files:
content/components/display/mipi_dsi.md
🪛 GitHub Check: build
content/components/display/mipi_dsi.md
[failure] 51-51:
Multiple consecutive blank lines [Expected: 1; Actual: 2]
🪛 GitHub Actions: Lint
content/components/display/mipi_dsi.md
[error] 51-51: Markdownlint: MD012 - No multiple blank lines. Multiple consecutive blank lines detected (Expected: 1; Actual: 2).
Description:
Related issue (if applicable): fixes
Pull request in esphome with YAML changes (if applicable):
Checklist:
I am merging into
next
because this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
current
because this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.Link added in
/components/index.rst
when creating new documents for new components or cookbook.New Component Images
If you are adding a new component to ESPHome, you can automatically generate a standardized black and white component name image for the documentation.
To generate a component image:
Comment on this pull request with the following command, replacing
COMPONENT_NAME
with your component name in UPPER_CASE format with underscores (e.g.,BME280
,SHT3X
,DALLAS_TEMP
):The ESPHome bot will respond with a downloadable ZIP file containing the SVG image.
Extract the SVG file and place it in the
images/
folder of this repository.Use the image in your component's index table entry in
/components/index.rst
.Example: For a component called "DHT22 Temperature Sensor", use: