Migrate docs to developers.home-assistant.io #4215
Conversation
Move all documentation (except the kernel.md, for which it makes sense to be kept here) to developers.home-assistant.io. Just bluetooth.md was intentionally not preserved, as the information value was low and it was out of date anyway. See home-assistant/developers.home-assistant#2748
|
Warning Rate limit exceeded@sairon has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 13 minutes and 10 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis change removes a large set of internal documentation files from the repository, including detailed board-specific READMEs, configuration guides, and network/bluetooth documentation. The main README is updated to reference the official Home Assistant Operating System documentation website and the documentation contributors' repository, replacing previous internal links. Changes
Sequence Diagram(s)No sequence diagram generated as all changes pertain to documentation removal and reference updates. Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes ✨ Finishing Touches🧪 Generate unit tests
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. 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
🧹 Nitpick comments (1)
Documentation/README.md (1)
4-4: Remove polite wording to comply with internal style guideThe phrase “please refer to” violates the prescribed direct, authoritative tone for documentation.
-If you want to contribute to this documentation, please refer to the [home-assistant/developers.home-assistant][docs-repo] repository. +To contribute to this documentation, see the [home-assistant/developers.home-assistant][docs-repo] repository.
📜 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
⛔ Files ignored due to path filters (1)
Documentation/usb-disk.pngis excluded by!**/*.png
📒 Files selected for processing (17)
Documentation/README.md(1 hunks)Documentation/bluetooth.md(0 hunks)Documentation/boards/README.md(0 hunks)Documentation/boards/asus/README.md(0 hunks)Documentation/boards/generic-aarch64/README.md(0 hunks)Documentation/boards/generic-x86-64/README.md(0 hunks)Documentation/boards/hardkernel/README.md(0 hunks)Documentation/boards/hardkernel/odroid-c2.md(0 hunks)Documentation/boards/hardkernel/odroid-c4.md(0 hunks)Documentation/boards/hardkernel/odroid-m1.md(0 hunks)Documentation/boards/hardkernel/odroid-m1s.md(0 hunks)Documentation/boards/hardkernel/odroid-n2.md(0 hunks)Documentation/boards/hardkernel/odroid-xu4.md(0 hunks)Documentation/boards/ova/README.md(0 hunks)Documentation/boards/raspberrypi/README.md(0 hunks)Documentation/configuration.md(0 hunks)Documentation/network.md(0 hunks)
💤 Files with no reviewable changes (16)
- Documentation/boards/asus/README.md
- Documentation/boards/ova/README.md
- Documentation/bluetooth.md
- Documentation/boards/hardkernel/README.md
- Documentation/boards/raspberrypi/README.md
- Documentation/boards/generic-x86-64/README.md
- Documentation/boards/hardkernel/odroid-m1s.md
- Documentation/boards/generic-aarch64/README.md
- Documentation/network.md
- Documentation/configuration.md
- Documentation/boards/README.md
- Documentation/boards/hardkernel/odroid-xu4.md
- Documentation/boards/hardkernel/odroid-m1.md
- Documentation/boards/hardkernel/odroid-c4.md
- Documentation/boards/hardkernel/odroid-c2.md
- Documentation/boards/hardkernel/odroid-n2.md
🧰 Additional context used
📓 Path-based instructions (1)
*/**(html|markdown|md)
⚙️ CodeRabbit Configuration File
*/**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.
- Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
- In step-by-step instructions, front the location phrase in the instructional sentence.
- In step-by-step instructions, front the 'goal' in the instructional sentence.
- In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
- do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'
*/**(html|markdown|md): - Use bold to mark UI strings.
If "" are used to mark UI strings, replace them by bold.
Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
Use sentence-style capitalization also in headings.
do not comment on HTML used for icons
Avoid flagging inline HTML for embedding videos in future reviews for this repository.
Files:
Documentation/README.md
| For the list of Linux kernel versions used currently in this branch of Home Assistant Operating System, see [kernel.md](./kernel.md). | ||
|
|
||
| [docs]: https://developers.home-assistant.io/docs/operating-system/ | ||
| [docs-repo]: https://github.com/home-assistant/developers.home-assistant/ |
There was a problem hiding this comment.
Is there anything remaining in Documentation/?
If not, I suggest to move this just to the global README.md, it will have better visibility as well.
There was a problem hiding this comment.
Yeah, there's kernel.md. Maybe we could add a Documentation section to the top-level readme a move this paragraph over, but I still prefer to keep kernel.md here to make tracking kernel versions in past releases via blame easier.
Move all documentation (except the kernel.md, for which it makes sense to be kept here) to developers.home-assistant.io.
Just bluetooth.md was intentionally not preserved, as the information value was low and it was out of date anyway.
See home-assistant/developers.home-assistant#2748
Summary by CodeRabbit