Enhance in-app tooltips for clarity #1165
Conversation
WalkthroughUpdated text in front/plugins/sync/config.json: clarified hub_url guidance (GraphQL port URL without trailing slash) and corrected a typo; reworded node_name description to be clearer without changing constraints. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
✨ 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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
front/plugins/sync/config.json (2)
124-133: Broken HTML tags in localized descriptions (ES/DE).Closing tags are malformed and will render incorrectly.
- "string": "Solo está habilitado si selecciona <code>schedule</code> en la configuración <a href=\"#SYNC_RUN\"><code>SYNC_RUN</code></a>. Asegúrese de ingresar la programación en el formato similar a cron correcto (por ejemplo, valide en <a href=\"https://crontab.guru/\" target=\"_blank\">crontab.guru</a>). Por ejemplo, ingresar <code>0 4 * * *</code> ejecutará el escaneo después de las 4 a.m. en el <a onclick=\"toggleAllSettings()\" href=\"#TIMEZONE\"><code>TIMEZONE</ código> que configuró arriba</a>. Se ejecutará la PRÓXIMA vez que pase el tiempo." + "string": "Solo está habilitado si selecciona <code>schedule</code> en la configuración <a href=\"#SYNC_RUN\"><code>SYNC_RUN</code></a>. Asegúrese de ingresar la programación en el formato similar a cron correcto (por ejemplo, valide en <a href=\"https://crontab.guru/\" target=\"_blank\">crontab.guru</a>). Por ejemplo, ingresar <code>0 4 * * *</code> ejecutará el escaneo después de las 4 a.m. en el <a onclick=\"toggleAllSettings()\" href=\"#TIMEZONE\"><code>TIMEZONE</code> que configuró arriba</a>. Se ejecutará la PRÓXIMA vez que pase el tiempo."- "string": "Nur aktiviert, wenn Sie <code>schedule</code> in der <a href=\"#SYNC_RUN\"><code>SYNC_RUN</code>-Einstellung</a> auswählen. Stellen Sie sicher, dass Sie den Zeitplan im richtigen Cron-ähnlichen Format eingeben (z. B. validieren unter <a href=\"https://crontab.guru/\" target=\"_blank\">crontab.guru</a>). Wenn Sie beispielsweise <code>0 4 * * *</code> eingeben, wird der Scan nach 4 Uhr morgens in der <a onclick=\"toggleAllSettings()\" href=\"#TIMEZONE\"><code>TIMEZONE</ ausgeführt. Code> den Sie oben festgelegt haben</a>. Wird das NÄCHSTE Mal ausgeführt, wenn die Zeit vergeht." + "string": "Nur aktiviert, wenn Sie <code>schedule</code> in der <a href=\"#SYNC_RUN\"><code>SYNC_RUN</code>-Einstellung</a> auswählen. Stellen Sie sicher, dass Sie den Zeitplan im richtigen Cron-ähnlichen Format eingeben (z. B. validieren unter <a href=\"https://crontab.guru/\" target=\"_blank\">crontab.guru</a>). Wenn Sie beispielsweise <code>0 4 * * *</code> eingeben, wird der Scan nach 4 Uhr morgens in der <a onclick=\"toggleAllSettings()\" href=\"#TIMEZONE\"><code>TIMEZONE</code> den Sie oben festgelegt haben</a> ausgeführt. Wird das NÄCHSTE Mal ausgeführt, wenn die Zeit vergeht."
663-666: Close unmatched<div>in replacement string
The replacement opens<div style='text-align:center'>but ends with<div></div>instead of closing the outer<div>. Update to:- "replacement": "<div style='text-align:center'><i class='fa-solid fa-square-check'></i><div></div>" + "replacement": "<div style='text-align:center'><i class='fa-solid fa-square-check'></i></div>"Check other replacements for matching open/close tags.
🧹 Nitpick comments (2)
front/plugins/sync/config.json (2)
272-275: Polish tooltip: fix capitalization/punctuation and tighten phrasing.Lowercase “Without”, add a final period, and clarify the instruction.
- "string": "If specified, this node will push data to the <code>GRAPHQL_PORT</code> API of the target. Use the target device <code>GRAPHQL_PORT</code> URL Without a trailing slash, for example <code>http://192.168.1.82:20212</code>" + "string": "If set, this node pushes data to the target's GraphQL API on <code>GRAPHQL_PORT</code>. Enter the target device's base URL with that port, without a trailing slash (e.g., <code>http://192.168.1.82:20212</code>)."Optional: consider raising maxLength above 50 to accommodate longer hostnames/IPv6 URLs.
297-300: Add terminal period; keep guidance concise.Minor copy edit for consistency.
- "string": "The unique name of this node, without spaces or special characters, such as <code>Node_Vlan01</code>" + "string": "The unique name of this node, without spaces or special characters (e.g., <code>Node_Vlan01</code>)."Optional: add input validation (regex) to enforce allowed characters.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
front/plugins/sync/config.json(2 hunks)
🔇 Additional comments (1)
front/plugins/sync/config.json (1)
336-340: Verify option key name “ordeable”.Is this meant to be “orderable”/“reorderable”? If the UI expects a specific key, this typo will be ignored.
|
Thanks a lot @adamoutler 🙏 |
While performing setup of
SYNCI felt the descriptions were confusing. I ended up going to the documentation as the tips were confusing. This PR aims to improve clarity and remove my need to visit the docs in the future.Summary by CodeRabbit