Remove references to info.md and render_readme

[ludeeus]

Closes hacs/integration#3994

[coderabbitai]

Walkthrough

Walkthrough

The updates to the documentation focus on clarifying the file structure requirements for various Home Assistant repositories, including AppDaemon apps, Python scripts, integrations, and themes. Key changes involve the removal of references to the info.md file and specifying the necessity of certain directories in repository structures to enhance usability and eliminate confusion for developers.

Changes

Files	Change Summary
source/docs/publish/appdaemon.md	Clarified that the main application file path must include the apps directory.
source/docs/publish/include.md	Removed the entire "Check Info" section, suggesting a consolidation of requirements.
source/docs/publish/integration.md	Removed references to info.md, indicating it's no longer necessary for integration repositories.
source/docs/publish/python_script.md	Emphasized the requirement for the python_scripts directory in the main script file path.
source/docs/publish/start.md	Eliminated the optional info.md section and clarified the render_readme key's description.
source/docs/publish/theme.md	Updated to exclude an invalid file example, clarifying the acceptable file structure for themes.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Documentation
    participant Repository

    User->>Documentation: Request for repository structure guidance
    Documentation->>Repository: Check for valid file paths
    Repository->>Documentation: Return valid structure requirements
    Documentation-->>User: Provide updated guidance

Loading

Assessment against linked issues

Objective	Addressed	Explanation
info.md and render_readme: false is not working (#[3994])	✅
Integration page always shows readme.md (#[3994])	❌	The issue is not directly addressed in this update.

Remember, if your repository structure isn't up to snuff, it might just become the "Missed Connection" of the coding world! Keep it tidy, folks! 🐰✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[coderabbitai]

Actionable comments posted: 1

[danielgospodinow]

@ludeeus, so this means that info.md is no longer rendered in HACS for a custom integration? And instead the README is rendered by default?