Improve readability of Log Levels

[Undearius]

Description:

Change the format of log levels to a table instead of a bullet list to make the association of the level and description more clear.

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:

1. 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):

   @esphomebot generate image COMPONENT_NAME
   

2. The ESPHome bot will respond with a downloadable ZIP file containing the SVG image.

3. Extract the SVG file and place it in the images/ folder of this repository.

4. Use the image in your component's index table entry in /components/index.rst.

Example: For a component called "DHT22 Temperature Sensor", use:

@esphomebot generate image DHT22

[coderabbitai]

Walkthrough

Reformatted the Log Levels section in content/components/logger.md: replaced multi-line bullets and per-level narrative blocks with a single compact table listing Level, Colour, and Description. Added a warning note for VERY_VERBOSE. No changes to level names, semantics, exported declarations, or behavior.

Changes

Cohort / File(s)	Summary
Documentation formatting content/components/logger.md	Replaced multi-line bullet list and per-level descriptive blocks with a structured table (Level, Colour, Description). Standardized colour names, added a color/description table and a warning note for VERY_VERBOSE, removed per-level narrative blocks and inline color notes. No functional or API changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Single documentation file; formatting-only edits.
• No code, logic, or API changes.

Suggested reviewers

• jesserockz

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'Improve readability of Log Levels' clearly and concisely describes the main change: converting log levels documentation from a narrative bullet list to a table format for better clarity.
Description check	✅ Passed	The description explains the change (converting log levels from bullet list to table format) and is directly related to the changeset, despite including standard checklist templates.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7e09a1c and 70eb0f0.

📒 Files selected for processing (1)

• content/components/logger.md (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• content/components/logger.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Build

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 65369f6 and ae60b93.

📒 Files selected for processing (1)

• content/components/logger.md (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

**

⚙️ CodeRabbit configuration file

• Do not generate or add any sequence diagrams

Files:

• content/components/logger.md

🧠 Learnings (2)

📓 Common learnings

Learnt from: jesserockz
Repo: esphome/esphome-docs PR: 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.

📚 Learning: 2025-08-11T12:34:51.506Z

Learnt from: oarcher
Repo: esphome/esphome-docs PR: 5224
File: components/logger.rst:254-261
Timestamp: 2025-08-11T12:34:51.506Z
Learning: In ESPHome logger configuration, the `initial_level` option works together with the `logs` tag mapping. When `initial_level` is set (e.g., to ERROR), it sets the global runtime log level, but tags specified in the `logs` section will use their specified levels regardless of the `initial_level` setting. This means you can compile verbose logs with `level: VERBOSE`, start with minimal logging using `initial_level: ERROR`, and still have specific components like `wifi: VERBOSE` remain verbose without needing `on_boot` automation and `logger.set_level` actions.

Applied to files:

• content/components/logger.md

🪛 GitHub Actions: CI

content/components/logger.md

[error] 137-137: MD033/no-inline-html Inline HTML [Element: br]

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Build

🔇 Additional comments (1)

content/components/logger.md (1)

129-137: Excellent restructuring of log levels into table format.

The conversion from bullet points to a table significantly improves the visual association between each log level, its color representation, and its description. The information content is well-preserved, and the layout is clean and easy to scan.

[netlify]

✅ Deploy Preview for esphome ready!

Name	Link
🔨 Latest commit	70eb0f0
🔍 Latest deploy log	https://app.netlify.com/projects/esphome/deploys/6934f675d612b30008a4bb92
😎 Deploy Preview	https://deploy-preview-5735--esphome.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.