Remove links to experimental docs #731

ludeeus · 2024-05-28T06:26:20Z

No description provided.

coderabbitai · 2024-05-28T06:26:47Z

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 3a75ff8 and 6334b37.

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

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 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 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.

emontnemery

LGTM 👍

coderabbitai

Actionable comments posted: 0

Outside diff range comments (4)

src/data/hacs.ts (1)
Line range hint 24-24: Consider specifying a more appropriate type instead of any for the log property in the Hacs interface to improve type safety.
-  log: any;
+  log: Record<string, unknown>; // or a more specific type if applicable
src/components/dialogs/hacs-download-dialog.ts (2)
Line range hint 38-38: Consider replacing any types with more specific types to enhance type safety and code maintainability.
-  private _error?: any;
+  private _error?: Error; // or a more specific error type if applicable

-  catch (err: any) {
+  catch (err: Error) { // or a more specific error type if applicable
Also applies to: 271-271

Line range hint 90-90: Avoid using non-null assertions. Consider adding checks or default values to ensure the properties are defined before use.

Also applies to: 142-142, 143-143, 148-148, 158-158, 215-215, 218-218, 226-226, 279-279, 280-280, 281-281, 286-286, 294-294, 295-295, 295-296
src/dashboards/hacs-dashboard.ts (1)
Line range hint 159-159: Avoid using template literals where not necessary. Use a simpler string concatenation or direct string instead.
- mainWindow.open(`https://github.com/hacs`, "_blank", "noreferrer=true");
+ mainWindow.open("https://github.com/hacs", "_blank", "noreferrer=true");

Remove links to experimental docs

6334b37

emontnemery suggested changes May 28, 2024

View reviewed changes

coderabbitai bot reviewed May 28, 2024

View reviewed changes

coderabbitai bot approved these changes May 28, 2024

View reviewed changes

ludeeus merged commit 07b555c into main May 28, 2024
3 checks passed

ludeeus deleted the remove-experimental-docs branch May 28, 2024 06:41

emontnemery mentioned this pull request May 28, 2024

Remove code paths only used in non-experimental mode hacs/integration#3728

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove links to experimental docs #731

Remove links to experimental docs #731

ludeeus commented May 28, 2024

coderabbitai bot commented May 28, 2024 •

edited

Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

emontnemery left a comment

coderabbitai bot left a comment

Remove links to experimental docs #731

Remove links to experimental docs #731

Conversation

ludeeus commented May 28, 2024

coderabbitai bot commented May 28, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

emontnemery left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot commented May 28, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)