[ json ] Include json to use it #5166
Conversation
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughA documentation update was made to the JSON component guide, adding a note that users must explicitly include the Changes
Estimated code review effort1 (~2 minutes) Possibly related PRs
Suggested reviewers
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
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. 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
components/json.rst(1 hunks)
📓 Path-based instructions (1)
**
⚙️ CodeRabbit Configuration File
- Do not generate or add any sequence diagrams
Files:
components/json.rst
🧠 Learnings (2)
📓 Common learnings
Learnt from: jesserockz
PR: esphome/esphome-docs#4865
File: .github/workflows/needs-docs.yml:0-0
Timestamp: 2025-05-01T03:29:47.922Z
Learning: In the esphome-docs repository, the "current" label is automatically added by a bot to pull requests, making it a reliable indicator for the target branch.
Learnt from: clydebarrow
PR: esphome/esphome-docs#0
File: :0-0
Timestamp: 2025-05-05T05:08:25.575Z
Learning: For code blocks within YAML documents in ESPHome, maintain YAML format even when the content uses JSON-style syntax, since YAML is a superset of JSON, but not all YAML is valid JSON.
Learnt from: clydebarrow
PR: esphome/esphome-docs#0
File: :0-0
Timestamp: 2025-05-05T05:08:25.575Z
Learning: In ESPHome documentation, leading slashes in doc references are necessary when the source document is not at the root of the tree, as absolute paths to referenced documents are required in this context.
Learnt from: jesserockz
PR: esphome/esphome-docs#4901
File: changelog/2025.4.0.rst:124-126
Timestamp: 2025-05-12T00:02:50.869Z
Learning: In the ESPHome changelog structure, the "All changes" section should have the `:open:` attribute to be expanded by default, but the "Dependency Changes" section should NOT have this attribute as it should remain collapsed by default.
Learnt from: clydebarrow
PR: esphome/esphome-docs#4874
File: guides/yaml.rst:324-324
Timestamp: 2025-05-05T05:12:25.536Z
Learning: When reviewing Sphinx documentation in the ESPHome project, leave the leading slashes in doc references (`:doc:/path`) intact, as they provide absolute paths which are required when the source document is not at the root of the tree.
Learnt from: jesserockz
PR: esphome/esphome-docs#4897
File: components/json.rst:130-131
Timestamp: 2025-05-28T05:38:05.301Z
Learning: In ESPHome documentation, the correct Sphinx role for API references is `:apiref:` (e.g., `:apiref:`http_request/http_request.h``), not `:api-ref:` or roles with spaces like `:http_request api ref:`.
Learnt from: realzoulou
PR: esphome/esphome-docs#4879
File: components/gps.rst:34-34
Timestamp: 2025-05-04T09:40:22.331Z
Learning: In ESPHome's GPS component, the `update_interval` parameter belongs to the `gps` component itself, not to individual sensors like `altitude`. It should be indented at the same level as the sensor configurations in the YAML.
Learnt from: trip5
PR: esphome/esphome-docs#4411
File: guides/beginners_guide_docker_desktop.rst:76-81
Timestamp: 2024-11-04T17:44:47.417Z
Learning: In the 'Beginner's Guide to Installing ESPHome on Docker Desktop' (`guides/beginners_guide_docker_desktop.rst`), when using Docker Desktop on Windows, it's unnecessary to add memory limits to the container, as Windows already handles resource limiting.
components/json.rst (3)
Learnt from: clydebarrow
PR: esphome/esphome-docs#0
File: :0-0
Timestamp: 2025-05-05T05:08:25.575Z
Learning: For code blocks within YAML documents in ESPHome, maintain YAML format even when the content uses JSON-style syntax, since YAML is a superset of JSON, but not all YAML is valid JSON.
Learnt from: jesserockz
PR: #4901
File: changelog/2025.4.0.rst:124-126
Timestamp: 2025-05-12T00:02:50.869Z
Learning: In the ESPHome changelog structure, the "All changes" section should have the :open: attribute to be expanded by default, but the "Dependency Changes" section should NOT have this attribute as it should remain collapsed by default.
Learnt from: clydebarrow
PR: esphome/esphome-docs#0
File: :0-0
Timestamp: 2025-05-05T05:08:25.575Z
Learning: In ESPHome documentation, leading slashes in doc references are necessary when the source document is not at the root of the tree, as absolute paths to referenced documents are required in this context.
🧰 Additional context used
📓 Path-based instructions (1)
**
⚙️ CodeRabbit Configuration File
- Do not generate or add any sequence diagrams
Files:
components/json.rst
🧠 Learnings (2)
📓 Common learnings
Learnt from: jesserockz
PR: esphome/esphome-docs#4865
File: .github/workflows/needs-docs.yml:0-0
Timestamp: 2025-05-01T03:29:47.922Z
Learning: In the esphome-docs repository, the "current" label is automatically added by a bot to pull requests, making it a reliable indicator for the target branch.
Learnt from: clydebarrow
PR: esphome/esphome-docs#0
File: :0-0
Timestamp: 2025-05-05T05:08:25.575Z
Learning: For code blocks within YAML documents in ESPHome, maintain YAML format even when the content uses JSON-style syntax, since YAML is a superset of JSON, but not all YAML is valid JSON.
Learnt from: clydebarrow
PR: esphome/esphome-docs#0
File: :0-0
Timestamp: 2025-05-05T05:08:25.575Z
Learning: In ESPHome documentation, leading slashes in doc references are necessary when the source document is not at the root of the tree, as absolute paths to referenced documents are required in this context.
Learnt from: jesserockz
PR: esphome/esphome-docs#4901
File: changelog/2025.4.0.rst:124-126
Timestamp: 2025-05-12T00:02:50.869Z
Learning: In the ESPHome changelog structure, the "All changes" section should have the `:open:` attribute to be expanded by default, but the "Dependency Changes" section should NOT have this attribute as it should remain collapsed by default.
Learnt from: clydebarrow
PR: esphome/esphome-docs#4874
File: guides/yaml.rst:324-324
Timestamp: 2025-05-05T05:12:25.536Z
Learning: When reviewing Sphinx documentation in the ESPHome project, leave the leading slashes in doc references (`:doc:/path`) intact, as they provide absolute paths which are required when the source document is not at the root of the tree.
Learnt from: jesserockz
PR: esphome/esphome-docs#4897
File: components/json.rst:130-131
Timestamp: 2025-05-28T05:38:05.301Z
Learning: In ESPHome documentation, the correct Sphinx role for API references is `:apiref:` (e.g., `:apiref:`http_request/http_request.h``), not `:api-ref:` or roles with spaces like `:http_request api ref:`.
Learnt from: realzoulou
PR: esphome/esphome-docs#4879
File: components/gps.rst:34-34
Timestamp: 2025-05-04T09:40:22.331Z
Learning: In ESPHome's GPS component, the `update_interval` parameter belongs to the `gps` component itself, not to individual sensors like `altitude`. It should be indented at the same level as the sensor configurations in the YAML.
Learnt from: trip5
PR: esphome/esphome-docs#4411
File: guides/beginners_guide_docker_desktop.rst:76-81
Timestamp: 2024-11-04T17:44:47.417Z
Learning: In the 'Beginner's Guide to Installing ESPHome on Docker Desktop' (`guides/beginners_guide_docker_desktop.rst`), when using Docker Desktop on Windows, it's unnecessary to add memory limits to the container, as Windows already handles resource limiting.
components/json.rst (3)
Learnt from: clydebarrow
PR: esphome/esphome-docs#0
File: :0-0
Timestamp: 2025-05-05T05:08:25.575Z
Learning: For code blocks within YAML documents in ESPHome, maintain YAML format even when the content uses JSON-style syntax, since YAML is a superset of JSON, but not all YAML is valid JSON.
Learnt from: jesserockz
PR: #4901
File: changelog/2025.4.0.rst:124-126
Timestamp: 2025-05-12T00:02:50.869Z
Learning: In the ESPHome changelog structure, the "All changes" section should have the :open: attribute to be expanded by default, but the "Dependency Changes" section should NOT have this attribute as it should remain collapsed by default.
Learnt from: clydebarrow
PR: esphome/esphome-docs#0
File: :0-0
Timestamp: 2025-05-05T05:08:25.575Z
Learning: In ESPHome documentation, leading slashes in doc references are necessary when the source document is not at the root of the tree, as absolute paths to referenced documents are required in this context.
Description:
It is not obvious (to everyone) that to use the json component you need to include it.
Related issue (if applicable): fixes
Pull request in esphome with YAML changes (if applicable):
Checklist:
I am merging into
nextbecause this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
currentbecause 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.rstwhen 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_NAMEwith 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: