Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Rename md files to markdown files #39282

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
May 28, 2025
Merged

Rename md files to markdown files #39282

merged 1 commit into from
May 28, 2025

Conversation

silamon
Copy link
Contributor

@silamon silamon commented May 28, 2025 •
edited by coderabbitai bot
Loading

Proposed change

Context for the change:

Now that we're talking about the analytics, the analytics for linkplay have never appeared on the analytics website. I need to view the documentation website to know.

It is because the "script" that generates https://www.home-assistant.io/integrations.json only looks for .markdown files.
linkplay is a .md file
https://github.com/home-assistant/home-assistant.io/blob/current/source/_integrations/linkplay.md

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 formatting in integration documentation files to use standard YAML frontmatter delimiters. No changes were made to the content, instructions, or structure of the documentation.

@home-assistant home-assistant bot added the current This PR goes into the current branch label May 28, 2025
@netlify Netlify
Copy link

netlify bot commented May 28, 2025 •
edited
Loading

✅ Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 9be004c
🔍 Latest deploy log https://app.netlify.com/projects/home-assistant-docs/deploys/6836cc76ca05aa00090c140f
😎 Deploy Preview https://deploy-preview-39282--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 project configuration.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented May 28, 2025

📝 Walkthrough

Walkthrough

This update applies consistent formatting to the markdown documentation files for several integrations by standardizing the YAML frontmatter delimiters and, in one case, list marker symbols. No content, logic, or structural changes were made to the documentation, and there are no modifications to any code or exported entities.

Changes

Files Change Summary
source/_integrations/eafm.markdown
source/_integrations/ipp.markdown
source/_integrations/locative.markdown
source/_integrations/motionmount.markdown		 Changed YAML frontmatter delimiters from ---- to ---; no content or structural changes.
source/_integrations/linkplay.markdown Changed list and block delimiters from hyphens (-) to plus signs (+); no content or structural changes.

Sequence Diagram(s)

No sequence diagram is generated as the changes are limited to documentation formatting and do not affect control flow or features.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 600c511 and 9be004c.

📒 Files selected for processing (5)
  • source/_integrations/eafm.markdown (1 hunks)
  • source/_integrations/ipp.markdown (1 hunks)
  • source/_integrations/linkplay.markdown (1 hunks)
  • source/_integrations/locative.markdown (1 hunks)
  • source/_integrations/motionmount.markdown (1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/motionmount.markdown

[grammar] ~51-~51: You’ve repeated a verb. Did you mean to only write one of them?
Context: ...ets. Changes to the presets are {% term polling polled %}, by default every 60 seconds.

...

(REPEATED_VERBS)

source/_integrations/locative.markdown

[uncategorized] ~11-~11: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ps://www.locative.app/). Locative is an open source app for [iOS](https://apps.apple.com/us...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

[style] ~17-~17: As a shorter alternative for ‘able to’, consider using “can not”.
Context: ... that URL, updating Home Assistant. You are not able to specify a device name in Locative. Inst...

(BE_ABLE_TO)

[uncategorized] ~17-~17: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...have created on its first GET. If you had been or are using Owntracks as well, yo...

(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)

source/_integrations/linkplay.markdown

[grammar] ~48-~48: Did you mean “saving”? Or maybe you should add a pronoun? In active voice, ‘allow’ + ‘to’ takes an object, usually a pronoun.
Context: ... Companion apps, such as 4stream, allow to save music presets (for example, Spotify pla...

(ALLOW_TO)

🪛 markdownlint-cli2 (0.17.2)
source/_integrations/locative.markdown

20-20: Images should have alternate text (alt text)
null

(MD045, no-alt-text)

source/_integrations/linkplay.markdown

25-25: Trailing spaces
Expected: 0 or 2; Actual: 1

(MD009, no-trailing-spaces)

29-29: Trailing spaces
Expected: 0 or 2; Actual: 1

(MD009, no-trailing-spaces)

30-30: Trailing spaces
Expected: 0 or 2; Actual: 1

(MD009, no-trailing-spaces)

36-36: Trailing spaces
Expected: 0 or 2; Actual: 1

(MD009, no-trailing-spaces)

45-45: Trailing spaces
Expected: 0 or 2; Actual: 1

(MD009, no-trailing-spaces)

48-48: Trailing spaces
Expected: 0 or 2; Actual: 1

(MD009, no-trailing-spaces)

53-53: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

54-54: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - home-assistant-docs
  • GitHub Check: Header rules - home-assistant-docs
  • GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (5)
source/_integrations/eafm.markdown (1)

1-11: Standardize YAML frontmatter delimiters
The YAML frontmatter delimiters have been updated to the standard three-dash (---) syntax, aligning this file with Home Assistant’s documentation guidelines. No actual content or metadata fields were modified.

source/_integrations/ipp.markdown (1)

1-12: Standardize YAML frontmatter delimiters
The YAML frontmatter block now uses the canonical three-dash (---) markers, matching the formatting applied across other integration docs. The underlying content remains unchanged.

source/_integrations/locative.markdown (1)

1-9: Standardize YAML frontmatter delimiters
Frontmatter has been normalized to use three-dash (---) delimiters, ensuring consistency with Home Assistant’s markdown standards. No descriptive text or configuration fields have been altered.

source/_integrations/motionmount.markdown (1)

1-21: Standardize YAML frontmatter delimiters
The opening and closing delimiters for the frontmatter have been standardized to ---, in line with the rest of the docs. All configuration entries and prose remain intact.

source/_integrations/linkplay.markdown (1)

1-17: Standardize YAML frontmatter delimiters
This file’s frontmatter now correctly uses three-dash (---) separators, conforming with the formatting conventions applied across integration documentation. No semantic changes were introduced.

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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need 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)

  • @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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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 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.

@silamon silamon mentioned this pull request May 28, 2025
Merged
8 tasks
@joostlek joostlek merged commit a6e059d into current May 28, 2025
9 checks passed
@joostlek joostlek deleted the md-files branch May 28, 2025 09:03
@github-actions github-actions bot locked and limited conversation to collaborators May 29, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@joostlek joostlek joostlek approved these changes

Assignees
No one assigned
Labels
current This PR goes into the current branch
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@silamon @joostlek