-
-
Notifications
You must be signed in to change notification settings - Fork 8k
Improve Growatt Server documentation for bronze tier compliance #41668
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.
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
base: current
Are you sure you want to change the base?
Improve Growatt Server documentation for bronze tier compliance #41668
Conversation
- Add removal instructions section (required for bronze tier) - Add troubleshooting section with common issues and solutions - Account lockout and terms acceptance in ShinePhone app - Rate limiting workarounds - HA restart prevention tips - Add known limitations section documenting rate limiting - Improve clarity: change "sensor logs into" to "integration connects to" - Use "entities" instead of just "sensors" for better accuracy - Fix markdown linter warnings by wrapping bare URLs in backticks
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
| - For users in China: `https://openapi-cn.growatt.com/` | ||
| - For users in North America: `https://openapi-us.growatt.com/` | ||
| - For users in other regions: `https://openapi.growatt.com/` | ||
| - SMTEN server: `http://server.smten.com/` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure if it is best practice to have links within backticks. While it may visually look better, this will no longer keep the link clickable and a user would have to either manually enter or copy the URL.
|
Good catch on the formatting concern! However, these URLs shouldn't be clickable because they're API endpoints that users need to copy and paste into their Growatt integration configuration - they're not web pages meant to be visited in a browser. If clicking these URLs was encouraged, users would try to visit them in their browser (which isn't useful) instead of copying them into their HA configuration. Ive changed to code blocks that users can copy. What do you think about this? Is it better or do you want me to move back to clickable links? |
Ah, I see. Sorry, didn't catch that the first time. I think in that case it does make sense to make the links non-clickable and the solution with embedding them in a text block, which allows copying is probably the best way to approach this. |
Proposed change
This PR improves the Growatt Server integration documentation to meet bronze tier quality scale requirements and provide better user guidance.
Changes:
docs-removal-instructionsruleType of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.