Skip to content
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

Cleanup documentation #118

Merged
merged 1 commit into from
Apr 7, 2024
Merged

Cleanup documentation #118

merged 1 commit into from
Apr 7, 2024

Conversation

nylonee
Copy link
Owner

@nylonee nylonee commented Apr 7, 2024

Thanks @glensc for the spot!

We'll just say that the delete configuration is disabled, a user can go to the Configuration readme to find out more about how to configure it (it now depends on whether they're using environment variables, config file or java properties)

Copy link

coderabbitai bot commented Apr 7, 2024

Walkthrough

The recent update focuses on modifying the documentation to clarify the functionality regarding the automatic deletion of content from Sonarr/Radarr when an item is removed from the user's watchlist. Specifically, it highlights that this feature is turned off by default, ensuring users are aware they must actively enable it if desired.

Changes

File(s) Change Summary
README.md Removed reference to auto-deletion feature in Sonarr/Radarr being configurable, emphasized it's disabled by default.

🐰
In the land of code and sun,
A tiny change has just begun.
With a hop, skip, and a leap,
We made a change, not too deep.
No more confusion, no more strife,
We aim to simplify your digital life.
🌟📚

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:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • 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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 4c43573 and 1519fe3.
Files selected for processing (1)
  • README.md (1 hunks)
Additional comments not posted (1)
README.md (1)

29-29: Clarification on feature status improves documentation clarity.

The update clearly states that the feature for deleting content from Sonarr/Radarr when an item is removed from the watchlist is disabled by default. This change enhances the documentation's clarity and helps set the right expectations for users.

@nylonee nylonee merged commit f7eb987 into main Apr 7, 2024
2 checks passed
@nylonee nylonee deleted the cleanup-delete-sync-documentation branch April 7, 2024 11:27
@glensc
Copy link
Collaborator

glensc commented Apr 7, 2024

Ref to original discussion:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants