Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings
This repository was archived by the owner on Aug 16, 2025. It is now read-only.

add admonitions for the pro plan#173

Merged
harjotgill merged 5 commits intomainfrompro_plan
Dec 13, 2024
Merged

add admonitions for the pro plan#173

harjotgill merged 5 commits intomainfrompro_plan
Dec 13, 2024

Conversation

@harjotgill
Copy link
Contributor

No description provided.

@coderabbitai
Copy link
Contributor

coderabbitaibot commentedDec 13, 2024•
edited
Loading

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request involves the deletion of two documentation files,docs/about/features.md anddocs/about/pricing.md, which provided detailed information about CodeRabbit's features and pricing plans, respectively. Multiple documentation files across various sections have been updated to include a new component,ProPlanNotice, enhancing the presentation of information related to the Pro Plan. Additionally, minor modifications were made to the sidebar positions and content rephrasing for clarity in several documents, while the Docusaurus configuration file was updated to change the GitHub link in the navigation bar.

Changes

File PathChange Summary
docs/about/features.mdDeleted; detailed descriptions of features related to pull request reviews.
docs/about/pricing.mdDeleted; comprehensive information regarding pricing plans and subscription management.
docs/finishing-touches/docstrings.mdAdded<ProPlanNotice />; changed beta warning to info box; minor formatting updates.
docs/getting-started/configure-coderabbit.mdUpdated sidebar position from 3 to 2; rephrased content for clarity.
docs/getting-started/support.mdAdded metadata fieldsidebar_position: 3; organized support contact guidance.
docs/guides/ondemand-reports.mdChangedsidebar_label from "On-demand Reports (Beta)" to "On-demand Reports"; added<ProPlanNotice />.
docs/guides/review-instructions.mdAdded<ProPlanNotice />; new section on AST-based instructions for customizing code reviews.
docs/integrations/knowledge-base.mdAdded<ProPlanNotice /> for Jira and Linear integration sections.
docs/tools/*.md (multiple files)Added<ProPlanNotice /> to various tool documentation files (Actionlint, Biome, Checkov, etc.).
docusaurus.config.tsUpdated GitHub link in navbar fromhttps://github.com/coderabbitai tohttps://github.com/coderabbitai/coderabbit-docs.
src/components/ProPlanNotice.mdxNew file added; contains information about the Pro Plan feature.

Sequence Diagram(s)

sequenceDiagram    participant User    participant CodeRabbit    participant Documentation    User->>Documentation: Access Features or Pricing    Documentation-->>User: Display Features/Pricing Information    User->>CodeRabbit: Inquire about Pro Plan    CodeRabbit-->>User: Provide Pro Plan Details
Loading

Possibly related PRs

Suggested reviewers

  • aravindputrevu
  • tyaga001
  • NatoBoram

Poem

🐇 In the land of CodeRabbit, changes abound,
Features and pricing no longer are found.
ProPlan's notice now takes the stage,
Guiding our users, turning the page.
With clarity and structure, our docs now shine,
Hop along, dear friends, all will be fine! 🌟

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between67e4f2f and2a45c8d.

📒 Files selected for processing (3)
  • docs/faq.md (1 hunks)
  • docs/tools/circleci.md (1 hunks)
  • docs/tools/swiftlint.md (2 hunks)

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 withCodeRabbit:

  • 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 generate docstrings togenerate docstrings for this PR. (Experiment)
  • @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 theconfiguration 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 ourDocumentation for detailed information on how to use CodeRabbit.
  • Join ourDiscord Community to get help, request features, and share feedback.
  • Follow us onX/Twitter for updates and announcements.

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pagesbot commentedDec 13, 2024•
edited
Loading

Deploying coderabbit-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit:2a45c8d
Status:⚡️  Build in progress...

View logs

@harjotgillharjotgill requested a review froma team as acode ownerDecember 13, 2024 01:36
Copy link
Contributor

@coderabbitaicoderabbitaibot 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

🧹 Outside diff range and nitpick comments (6)
docs/tools/circleci.md (1)

Line range hint17-18:Fix typo in file paths

The quote marks are incorrectly placed at the end of the file paths.

-- `.circleci/config.yml"`-- `.circleci/config.yaml"`++ `.circleci/config.yml`++ `.circleci/config.yaml`
docs/tools/swiftlint.md (1)

Line range hint27-27:Fix incorrect tool name in configuration section

The configuration section incorrectly mentions "Ruff" instead of "SwiftLint".

-Ruff supports the following config files:+SwiftLint supports the following config files:
docs/getting-started/support.md (1)

Line range hint1-7:Consider adding ProPlanNotice component

Given that this PR's objective is to add pro plan admonitions across the documentation, consider adding the ProPlanNotice component to this file as well, particularly before the Support Tickets section which might be a pro-only feature.

docs/finishing-touches/docstrings.md (1)

8-8:Consider using path alias for component imports

Instead of using relative path with@site, consider using a path alias for better maintainability.

-import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';+import ProPlanNotice from '@components/ProPlanNotice.mdx';
docs/integrations/knowledge-base.md (2)

35-37:Consider consolidating ProPlanNotice components

Since both Jira and Linear integrations are pro features, consider placing a single ProPlanNotice component at the beginning of the Issues section instead of having separate notices for each integration.

 ## Issues  The issues knowledge base allows CodeRabbit to use the context from linked and related issues while reviewing the code.++```mdx-code-block+import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';+<ProPlanNotice />+```  ### Jira {#jira}--```mdx-code-block-import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';--<ProPlanNotice />-```

16-20:Fix formatting inconsistency

The first ProPlanNotice usage has extra newlines while the second doesn't. Maintain consistent formatting across all component usages.

Also applies to: 35-37

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between15947a4 and67e4f2f.

⛔ Files ignored due to path filters (2)
  • docs/about/_category_.yaml is excluded by!**/*.yaml
  • docs/finishing-touches/_category_.yaml is excluded by!**/*.yaml
📒 Files selected for processing (33)
  • docs/about/features.md (0 hunks)
  • docs/about/pricing.md (0 hunks)
  • docs/finishing-touches/docstrings.md (1 hunks)
  • docs/getting-started/configure-coderabbit.md (1 hunks)
  • docs/getting-started/support.md (1 hunks)
  • docs/guides/ondemand-reports.md (1 hunks)
  • docs/guides/review-instructions.md (1 hunks)
  • docs/integrations/knowledge-base.md (2 hunks)
  • docs/tools/actionlint.md (1 hunks)
  • docs/tools/biome.md (1 hunks)
  • docs/tools/buf.md (1 hunks)
  • docs/tools/checkov.md (1 hunks)
  • docs/tools/circleci.md (1 hunks)
  • docs/tools/cppcheck.md (1 hunks)
  • docs/tools/detekt.md (1 hunks)
  • docs/tools/eslint.md (1 hunks)
  • docs/tools/gitleaks.md (1 hunks)
  • docs/tools/golangci-lint.md (1 hunks)
  • docs/tools/hadolint.md (1 hunks)
  • docs/tools/languagetool.md (1 hunks)
  • docs/tools/markdownlint.md (1 hunks)
  • docs/tools/phpstan.md (1 hunks)
  • docs/tools/pmd.md (1 hunks)
  • docs/tools/regal.md (1 hunks)
  • docs/tools/rubocop.md (1 hunks)
  • docs/tools/ruff.md (1 hunks)
  • docs/tools/semgrep.md (1 hunks)
  • docs/tools/shellcheck.md (1 hunks)
  • docs/tools/swiftlint.md (1 hunks)
  • docs/tools/tools.md (1 hunks)
  • docs/tools/yamllint.md (1 hunks)
  • docusaurus.config.ts (1 hunks)
  • src/components/ProPlanNotice.mdx (1 hunks)
💤 Files with no reviewable changes (2)
  • docs/about/pricing.md
  • docs/about/features.md
✅ Files skipped from review due to trivial changes (19)
  • docs/tools/actionlint.md
  • docs/tools/markdownlint.md
  • docs/tools/biome.md
  • docs/tools/ruff.md
  • docs/tools/semgrep.md
  • docs/tools/yamllint.md
  • src/components/ProPlanNotice.mdx
  • docs/tools/detekt.md
  • docs/tools/hadolint.md
  • docs/tools/shellcheck.md
  • docs/tools/gitleaks.md
  • docs/tools/cppcheck.md
  • docs/tools/phpstan.md
  • docs/tools/buf.md
  • docs/tools/pmd.md
  • docs/tools/golangci-lint.md
  • docs/tools/eslint.md
  • docs/tools/languagetool.md
  • docs/getting-started/configure-coderabbit.md
🧰 Additional context used
🪛 LanguageTool
docs/finishing-touches/docstrings.md

[uncategorized] ~19-~19: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ...tive. :::info This feature is inbeta. ::: ## Usage Once you are don...

(HYPHENATED_LY_ADVERB_ADJECTIVE)

🔇 Additional comments (15)
docs/tools/circleci.md (1)

7-11:LGTM: ProPlanNotice component integration

The component is correctly imported and placed at the beginning of the documentation.

docs/tools/regal.md (1)

7-11:LGTM: Clean ProPlanNotice integration

The component is properly imported and integrated into the documentation, maintaining consistency with other tool documentation.

docs/tools/swiftlint.md (1)

7-11:LGTM: Consistent ProPlanNotice implementation

The component integration follows the established pattern across the documentation.

docs/tools/checkov.md (1)

7-11:LGTM! Verify the import path.

The ProPlanNotice component integration looks good. The placement after frontmatter is appropriate.

✅ Verification successful

Import path for ProPlanNotice component is valid

The verification confirms that:

  • The component exists atsrc/components/ProPlanNotice.mdx
  • It's widely used across the documentation with the same import pattern
  • The component is consistently imported and used in many other tool documentation files
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash# Verify the ProPlanNotice component exists at the specified pathtest -f src/components/ProPlanNotice.mdx||echo"Component file not found"

Length of output: 42

Script:

#!/bin/bash# Search for ProPlanNotice.mdx file in the repositoryfd"ProPlanNotice.mdx"# Search for any imports of ProPlanNotice componentrg -l"import.*ProPlanNotice"# Search for any usage of ProPlanNotice componentrg"<ProPlanNotice"

Length of output: 1961

docs/tools/rubocop.md (1)

7-11:LGTM! Consistent implementation.

The ProPlanNotice component integration matches the pattern used across other tool documentation files.

docs/guides/ondemand-reports.md (3)

3-3:LGTM! Removal of Beta designation.

The removal of "(Beta)" from the sidebar label indicates the feature has matured.

10-13:LGTM! Component integration.

The ProPlanNotice component is properly integrated alongside the existing ReportSchema component.

15-15:LGTM! Improved clarity in instructions.

The updates to the introduction and API key creation steps provide clearer guidance for users.

Also applies to: 20-21

docs/getting-started/support.md (1)

5-5:LGTM: Sidebar position update

The sidebar position is correctly set to 3.

docs/finishing-touches/docstrings.md (2)

7-11:LGTM: ProPlanNotice component integration

The ProPlanNotice component is correctly imported and placed at the beginning of the document.

17-20:Verify the rationale for changing warning to info

The change from warning to info box seems unrelated to the PR's objective of adding pro plan admonitions. Please verify if this change was intentional.

✅ Verification successful

Based on the search results from the previous commands, I can now generate a final response:

The info admonition usage is consistent with beta feature notifications

From the codebase search results, we can see that:::info admonitions are commonly used throughout the documentation for informational notices, while:::warning is specifically used for more critical or cautionary messages. Looking atearly-access.md, beta features are not marked with warnings anymore, making this change consistent with the documentation style guide.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash# Check git history for context on the beta notice changegit log -p -- docs/finishing-touches/docstrings.md| grep -A 5 -B 5"warning"

Length of output: 0

Script:

#!/bin/bash# Search for any warning or info admonitions in the docsrg -B2 -A2":::(warning|info)" docs/# Also check the current content of the specific filecat docs/finishing-touches/docstrings.md

Length of output: 5636

Script:

#!/bin/bash# Check the git history for this specific file to see the changegit log -p docs/finishing-touches/docstrings.md| grep -B5 -A5":::"

Length of output: 0

🧰 Tools
🪛 LanguageTool

[uncategorized] ~19-~19: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ...tive. :::info This feature is inbeta. ::: ## Usage Once you are don...

(HYPHENATED_LY_ADVERB_ADJECTIVE)

docs/integrations/knowledge-base.md (1)

16-20:LGTM: ProPlanNotice component integration for Jira

The ProPlanNotice component is correctly imported and placed before the Jira integration section.

docusaurus.config.ts (1)

214-214:LGTM! Improved GitHub link targeting.

The updated GitHub link now correctly points to the documentation repository instead of the organization page, making it easier for users to find and contribute to the documentation.

docs/tools/tools.md (1)

8-12:LGTM! Clean integration of Pro Plan notice.

The ProPlanNotice component is properly imported and integrated at an appropriate location in the document, maintaining good documentation structure.

docs/guides/review-instructions.md (1)

51-55:LGTM! Consistent Pro Plan notice placement.

The ProPlanNotice component is appropriately placed before the AST-based instructions section, maintaining documentation consistency.

@harjotgillharjotgill merged commitd318b00 intomainDec 13, 2024
2 of 4 checks passed
@harjotgillharjotgill deleted the pro_plan branchDecember 13, 2024 02:10
Sign up for freeto subscribe to this conversation on GitHub. Already have an account?Sign in.

Reviewers

1 more reviewer

@coderabbitaicoderabbitai[bot]coderabbitai[bot] approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@harjotgill
[8]ページ先頭
©2009-2025 Movatter.jp