docs: correct documentation for flat recommended configuration

[DaveMBush]

Issue Number: #6

Body

Update documentation to reflect the need to access .rules off of recommended

Summary by CodeRabbit

• Documentation
  • Enhanced clarity and usability of the eslint-plugin-rxjs documentation.
  • Updated installation instructions and configuration examples for both Flat Config and Legacy Config setups.
  • Expanded rules section with a comprehensive list of available rules, including recommendations and fixers.
  • Improved overall structure for better readability and comprehension.

[coderabbitai]

Walkthrough

The pull request introduces significant updates to the README.md file of the eslint-plugin-rxjs. Key modifications include the removal of certain rules, updates to installation and configuration instructions, and an enhanced presentation of available rules. The documentation now distinguishes between Flat Config and Legacy Config setups, with specific examples reflecting a new structure for recommended rules. Overall, these changes aim to improve clarity and usability for users of the plugin.

Changes

File	Change Summary
packages/eslint-plugin-rxjs/README.md	- Updated installation instructions, including the ESLint TypeScript parser. - Modified configuration examples for Flat and Legacy Configs, changing rxjs.configs.recommended to ...rxjs.configs.recommended.rules. - Expanded rules section with descriptions and indicators for recommended rules and fixers. - Enhanced overall structure for better readability.

Possibly related PRs

• docs: update readme files #4: The changes in this PR also focus on updating the README.md for the eslint-plugin-rxjs, including enhancements to the installation instructions and configuration examples, which directly relate to the modifications made in the main PR.

🐇 In the meadow, the rabbits play,
With clearer guides to lead the way.
The rules are set, the paths are bright,
Configs now shine, oh what a sight!
Hop along, dear friends, don’t delay,
With these updates, let’s code away! 🌼

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 using 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 do a full 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.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

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

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 46ec875. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

---

✅ Successfully ran 1 target

• nx affected -t lint test build

---

Sent with 💌 from NxCloud.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)

README.md (1)

Line range hint 1-24: Consider consolidating duplicate README files.

This README file appears to be identical to the one in packages/eslint-plugin-rxjs/. Having duplicate documentation can lead to maintenance issues where updates need to be synchronized across multiple files.

Consider either:

1. Keeping only one README at the repository root and removing the duplicate, or
2. Making one README the source of truth and having the other one reference it

packages/eslint-plugin-rxjs/README.md (1)

Line range hint 1-24: Consider consolidating duplicate README files.

This README file appears to be identical to the one at the repository root. Having duplicate documentation can lead to maintenance issues where updates need to be synchronized across multiple files.

Consider either:

1. Keeping only one README in the package directory and removing the root one, or
2. Making one README the source of truth and having the other one reference it

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 058bd97 and 46ec875.

📒 Files selected for processing (2)

• README.md (1 hunks)
• packages/eslint-plugin-rxjs/README.md (1 hunks)

🔇 Additional comments (2)

README.md (1)

77-77: LGTM! Configuration correction looks accurate.

The change to use ...rxjs.configs.recommended.rules is the correct way to access the recommended rules in flat config setup.

packages/eslint-plugin-rxjs/README.md (1)

77-77: LGTM! Configuration correction looks accurate.

The change to use ...rxjs.configs.recommended.rules is the correct way to access the recommended rules in flat config setup.