hacs / frontend

The frontend of HACS
MIT License
145 stars 82 forks source link

Remove links to experimental docs #731

Closed ludeeus closed 3 months ago

coderabbitai[bot] commented 3 months ago
Walkthrough ## Walkthrough The updates primarily focus on modifying URLs within various components and functions to point to new documentation paths. This includes changes in dialog components, dashboard actions, and data handling functions. Additionally, the `experimental` flag has been removed from the `HacsInfo` interface, and the `documentationUrl` function has been simplified to construct URLs directly without conditional logic. ## Changes | File Path | Change Summary | |------------------------------------|--------------------------------------------------------------------------------------------------| | `src/components/dialogs/...` | Updated hyperlink path in `HacsDownloadDialog` class. | | `src/dashboards/hacs-dashboard.ts` | Modified action functions to open new documentation and issue tracking URLs. | | `src/data/about.ts` | Updated links in `aboutHacsmarkdownContent` function by removing experimental flags and adjusting paths. | | `src/data/hacs.ts` | Removed the `experimental` boolean property from the `HacsInfo` interface. | | `src/tools/documentation.ts` | Simplified `documentationUrl` function by removing conditional domain selection based on the `experimental` flag. |

Recent Review Details **Configuration used: CodeRabbit UI** **Review profile: ASSERTIVE**
Commits Files that changed from the base of the PR and between 3a75ff8b11977c4e5b134036ebc1600434bfd158 and 6334b37a031d5e647cba16eeb94b65d050b2c7eb.
Files selected for processing (5) * src/components/dialogs/hacs-download-dialog.ts (1 hunks) * src/dashboards/hacs-dashboard.ts (2 hunks) * src/data/about.ts (1 hunks) * src/data/hacs.ts (1 hunks) * src/tools/documentation.ts (1 hunks)
Additional Context Used
Biome (29)
src/components/dialogs/hacs-download-dialog.ts (20)
38-38: Unexpected any. Specify a different type. --- 90-90: Forbidden non-null assertion. --- 142-142: Forbidden non-null assertion. --- 143-143: Forbidden non-null assertion. --- 148-148: Forbidden non-null assertion. --- 158-158: Forbidden non-null assertion. --- 178-178: Do not use template literals if interpolation and special-character handling are not needed. --- 215-215: Forbidden non-null assertion. --- 218-218: Forbidden non-null assertion. --- 226-226: Forbidden non-null assertion. --- 271-271: Unexpected any. Specify a different type. --- 279-279: Forbidden non-null assertion. --- 280-280: Forbidden non-null assertion. --- 281-281: Forbidden non-null assertion. --- 286-286: Forbidden non-null assertion. --- 294-294: Forbidden non-null assertion. --- 294-294: Forbidden non-null assertion. --- 295-295: Forbidden non-null assertion. --- 295-295: Forbidden non-null assertion. --- 295-296: Forbidden non-null assertion.
src/dashboards/hacs-dashboard.ts (8)
112-112: void is not valid as a constituent in a union type --- 159-159: Do not use template literals if interpolation and special-character handling are not needed. --- 526-526: Unexpected any. Specify a different type. --- 31-32: All these imports are only used as types. --- 32-33: All these imports are only used as types. --- 34-35: All these imports are only used as types. --- 47-48: All these imports are only used as types. --- 535-535: Avoid the use of spread (`...`) syntax on accumulators.
src/data/hacs.ts (1)
24-24: Unexpected any. Specify a different type.
Additional comments not posted (4)
src/tools/documentation.ts (1)
`1-2`: The updated `documentationUrl` function simplifies URL construction as intended.
src/data/about.ts (1)
`16-20`: The updated URLs in the `aboutHacsmarkdownContent` function correctly reflect the new documentation paths.
src/components/dialogs/hacs-download-dialog.ts (1)
`152-152`: The updated `learn_more` link path correctly points to the new documentation URL.
src/dashboards/hacs-dashboard.ts (1)
Line range hint `154-167`: The updated actions for documentation and issue tracking URLs correctly reflect the new paths.
--- 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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): > :bangbang: **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 full the 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 Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.