Standardize the usage of '?free-trial' parameter in login URLs across documentation #160

[syedalinaqihasni]

Fixes #160
Requester: @aravindputrevu

Summary:

• This PR ensures consistent usage of the ?free-trial parameter in all login URLs within the documentation.

Details:

• Reviewed all instances of login URLs in the documentation.
• Appended the ?free-trial parameter where it was missing, aligning with the usage pattern discussed in PR fix login issues - Update documentation for pricing clarity and integration instructions #159 and its comments.
• This standardization helps ensure users accessing the login page via docs are correctly directed to the intended trial flow.

Motivation:

To maintain clarity and consistency across documentation and provide a seamless user experience for new users accessing the trial version.

Reviewer Notes:

• Please verify if all login links now reflect the ?free-trial parameter.
• Let me know if there are cases where the parameter should not be applied.

[coderabbitai]

Walkthrough

The documentation across multiple files was updated to modify all references to the CodeRabbit login URL by appending the ?free-trial query parameter. This change standardizes the login links to direct users toward a free trial experience. No other procedural, textual, or structural changes were made.

Changes

File(s)	Change Summary
docs/getting-started/quickstart.md docs/getting-started/support.md docs/guides/install-vscode.md docs/overview/why-coderabbit.md docs/platforms/github-com.md docs/platforms/github-enterprise-server.md docs/platforms/platforms.md docs/platforms/self-hosted-gitlab.md	Updated all instances of the CodeRabbit login URL to include the ?free-trial query parameter. No additional content or instructions were changed.

Poem

A hop and a skip, a link to unveil,
Now every login leads to a free trial tale!
With ?free-trial in every URL,
The docs now guide where new users dwell.
🥕✨
So follow the links, don’t delay—
CodeRabbit’s free trial is just a click away!

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.

---

Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

✨ Finishing Touches

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Commit Unit Tests in branch feature/issue/160
• Post Copyable Unit Tests in Comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

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

17-17: Typographical nitpick
Consider hyphenating “bottom right corner” to “bottom-right corner” for improved readability.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~17-~17: Consider adding a hyphen.
Context: ...eam, click the help icon located in the bottom right corner of the [CodeRabbit UI](https://a...

(TOP_LEFT_CORNER)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 81a641c and f2a003e.

📒 Files selected for processing (8)

• docs/getting-started/quickstart.md (1 hunks)
• docs/getting-started/support.md (1 hunks)
• docs/guides/install-vscode.md (1 hunks)
• docs/overview/why-coderabbit.md (2 hunks)
• docs/platforms/github-com.md (1 hunks)
• docs/platforms/github-enterprise-server.md (2 hunks)
• docs/platforms/platforms.md (1 hunks)
• docs/platforms/self-hosted-gitlab.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/getting-started/support.md

[uncategorized] ~17-~17: Consider adding a hyphen.
Context: ...eam, click the help icon located in the bottom right corner of the [CodeRabbit UI](https://a...

(TOP_LEFT_CORNER)

🔇 Additional comments (13)

docs/platforms/platforms.md (1)

35-35: Standardized login link updated correctly
The footnote definition for [login] now includes ?free-trial, ensuring all platform links will direct users to the trial flow.

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

17-17: Support UI login URL updated to include trial parameter
The inline link now correctly appends ?free-trial to the CodeRabbit UI login, directing users to the trial experience.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~17-~17: Consider adding a hyphen.
Context: ...eam, click the help icon located in the bottom right corner of the [CodeRabbit UI](https://a...

(TOP_LEFT_CORNER)

docs/platforms/self-hosted-gitlab.md (2)

22-22: OAuth2 login link updated for trial flow
The “Login” link now includes ?free-trial, matching the updated pattern across documentation.

---

88-88: Callback URL appended with trial parameter
The OAuth2 callback URL correctly includes ?free-trial, ensuring users return to the trial-enabled login.

docs/guides/install-vscode.md (1)

17-17: VSCode extension account creation link standardized
The link to create a CodeRabbit account now appends ?free-trial, aligning with other onboarding flows.

docs/overview/why-coderabbit.md (3)

60-60: Trial signup link updated in Get Started info box
The “[sign up for a Free account]” link now includes ?free-trial, ensuring users hit the trial flow straight from the overview.

---

435-435: Free trial CTA link updated
The “Start your free trial today” link correctly carries the ?free-trial query parameter.

---

438-438: Primary “Sign Up Free” button URL standardized
The button’s href now appends ?free-trial, maintaining consistency across CTAs.

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

33-33: Correctly Updated Login Link
The appended ?free-trial parameter ensures users are directed into the free-trial flow as intended.

docs/platforms/github-com.md (1)

56-56: Consistent Free-Trial URL in UI Configuration
The link now includes ?free-trial, aligning the UI-config documentation with the standardized trial entry point.

docs/platforms/github-enterprise-server.md (3)

25-25: Append Free-Trial Parameter to Self-Hosted Login Link
The login link now correctly points to https://app.coderabbit.ai/login?free-trial, guiding GitHub Enterprise Server users into the trial flow.

---

55-55: Update OAuth App Authorization Callback URL
The Authorization callback URL now includes ?free-trial, ensuring OAuth flows initiate the trial experience.

---

85-85: Update GitHub App Callback URL
The GitHub App Callback URL correctly appends ?free-trial, maintaining consistency in the installation flow.