Skip to content

Move omit in TOC markers in alexa smart_home docs before header #38449

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
Merged
merged 1 commit into from
Apr 9, 2025
Merged

Move omit in TOC markers in alexa smart_home docs before header #38449

merged 1 commit into from
Apr 9, 2025

Conversation

jbouwh
Copy link
Contributor

@jbouwh jbouwh commented Apr 8, 2025 •
edited
Loading

Proposed change

Move omit in TOC markers in alexa smart_home docs before header to improve TOC build.
This fixes the broken links, but the TOC is still including the menu items.
Related to: #38084

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

  • Link to parent pull request in the codebase:
  • Link to parent pull request in the Brands repository:
  • This PR fixes or closes issue: fixes #

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • Documentation
    • Updated the formatting of section headers in the Alexa integration guide to streamline the table of contents for improved navigation. Content remains unchanged.

@jbouwh jbouwh requested a review from ochlocracy as a code owner April 8, 2025 19:16
@home-assistant home-assistant bot added the current This PR goes into the current branch label Apr 8, 2025
@netlify Netlify
Copy link

netlify bot commented Apr 8, 2025 •
edited
Loading

✅ Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit d1558ed
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/67f575f702dddb0008a10697
😎 Deploy Preview https://deploy-preview-38449--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@jbouwh jbouwh linked an issue Apr 8, 2025 that may be closed by this pull request
Website isn't omitting headers from TOC #38084
Open
@jbouwh jbouwh removed a link to an issue Apr 8, 2025
Website isn't omitting headers from TOC #38084
Open
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 8, 2025

📝 Walkthrough

Walkthrough

The changes adjust the formatting of header comments in the Alexa integration documentation file. The update moves the <!-- omit in toc --> comment from the beginning of several header lines to immediately before the header text. This modification applies to sections such as "Alexa locale", "Proactive events", "Configure filter", "Alexa Display Categories", "Binary Sensor not available in Routine Trigger", and "Token Invalid and no Refresh Token Available". The overall content and document structure remain unchanged.

Changes

File(s) Change Summary
source/_integrations/alexa.smart_home.markdown Relocated the <!-- omit in toc --> comment in header lines by placing it immediately before the header text for multiple sections without altering content.
📜 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 79495af and d1558ed.

📒 Files selected for processing (1)
  • source/_integrations/alexa.smart_home.markdown (4 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/alexa.smart_home.markdown

[style] ~428-~428: Consider using a more polite wording.
Context: ... optional, and are only required if you want to enable Alexa's proactive mode (i.e.,...

(IF_YOU_WANT)

[style] ~428-~428: Consider using a more polite wording.
Context: ...bled). Please note the following if you want to enable proactive mode: - There are ...

(IF_YOU_WANT)

[style] ~432-~432: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...d no refresh token available. Also, you need to restart your Home Assistant after each ...

(REP_NEED_TO_VB)

🔇 Additional comments (6)
source/_integrations/alexa.smart_home.markdown (6)

399-400: Improved TOC Marker Placement for "Alexa locale"
The <!-- omit in toc --> marker is now placed immediately before the "### Alexa locale" header. This improvement helps ensure that the header is properly omitted from the Table of Contents in accordance with the documentation standard.

425-426: TOC Marker Adjustment for "Proactive events" Section
The repositioning of the omit marker to directly precede the "### Proactive events" header enhances the clarity of the document and aligns with the intended TOC behavior.

434-435: Consistent Marker Placement for "Configure filter"
Moving the omit marker before the "### Configure filter" header ensures consistency across sections and prevents this header from appearing in the TOC.

457-458: Enhanced Formatting for "Alexa Display Categories"
The adjustment of placing the omit marker immediately before the "### Alexa Display Categories" header improves overall readability and adheres to the documentation guidelines for TOC generation.

1111-1112: Corrected Marker Placement for "Binary Sensor not available in Routine Trigger"
The relocate of the <!-- omit in toc --> marker to directly precede the header "### Binary Sensor not available in Routine Trigger" ensures that this section is omitted from the TOC as intended.

1117-1118: Proper Marker Positioning for "Token Invalid and no Refresh Token Available"
Placing the omit marker immediately before the "### Token Invalid and no Refresh Token Available" header aligns with the documentation improvements outlined in the PR objectives.

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
🪧 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.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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 or @coderabbitai title 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.

c0ffeeca7
c0ffeeca7 approved these changes Apr 9, 2025
View reviewed changes
Copy link
Contributor

@c0ffeeca7 c0ffeeca7 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, @jbouwh 👍

@github-project-automation github-project-automation bot moved this from Todo to Approved in Documentation PRs Apr 9, 2025
@c0ffeeca7 c0ffeeca7 merged commit f524aef into current Apr 9, 2025
9 checks passed
@c0ffeeca7 c0ffeeca7 deleted the alexa-move-no-toc-markers-before-header branch April 9, 2025 05:00
@github-project-automation github-project-automation bot moved this from Approved to Done in Documentation PRs Apr 9, 2025
@github-actions github-actions bot locked and limited conversation to collaborators Apr 10, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@c0ffeeca7 c0ffeeca7 c0ffeeca7 approved these changes

@ochlocracy ochlocracy Awaiting requested review from ochlocracy ochlocracy is a code owner

Assignees
No one assigned
Labels
current This PR goes into the current branch
Projects
No open projects
Documentation PRs
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jbouwh @c0ffeeca7