docs: fix grammar, formatting and clarity issues in docs#28832
docs: fix grammar, formatting and clarity issues in docs#28832sahitya-chandra merged 1 commit intocalcom:mainfrom
Conversation
📝 WalkthroughWalkthroughThe pull request updates documentation files with minor text adjustments and formatting improvements. In the introduction documentation, a quick start call-to-action phrase was rephrased. The Docker self-hosting guide received three updates: filename formatting was corrected with inline code quoting, a section header was modified for proper branding capitalization, and a grammar correction was made. The installation documentation was updated to properly format a filename reference with backticks. All modifications are documentation-only with no changes to exported entities or code logic. 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/self-hosting/docker.mdx (1)
121-121: Optional polish: capitalize “URL” for consistency.Line 121 still uses “base url”; consider “base URL” to match technical style in the rest of the docs.
✏️ Suggested wording tweak
-If you experience this error, it may be the way the default Auth callback in the server is using the WEBAPP_URL as a base url. The container does not necessarily have access to the same DNS as your local machine, and therefore needs to be configured to resolve to itself. You may be able to correct this by configuring `NEXTAUTH_URL=http://localhost:3000/api/auth`, to help the backend loop back to itself. +If you experience this error, it may be due to how the default Auth callback on the server uses `WEBAPP_URL` as a base URL. The container does not necessarily have access to the same DNS as your local machine and therefore needs to be configured to resolve to itself. You may be able to correct this by configuring `NEXTAUTH_URL=http://localhost:3000/api/auth` to help the backend loop back to itself.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/self-hosting/docker.mdx` at line 121, Update the phrasing to use consistent capitalization of "URL": change "base url" to "base URL" in the sentence referencing the default Auth callback and WEBAPP_URL so it reads e.g. "the default Auth callback in the server is using the WEBAPP_URL as a base URL"; ensure any other instances in the same sentence (WEBAPP_URL, NEXTAUTH_URL) remain uppercase "URL" for consistency.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/self-hosting/docker.mdx`:
- Line 121: Update the phrasing to use consistent capitalization of "URL":
change "base url" to "base URL" in the sentence referencing the default Auth
callback and WEBAPP_URL so it reads e.g. "the default Auth callback in the
server is using the WEBAPP_URL as a base URL"; ensure any other instances in the
same sentence (WEBAPP_URL, NEXTAUTH_URL) remain uppercase "URL" for consistency.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: d4940395-7362-4d87-90fd-c88b3a84dfe9
📒 Files selected for processing (3)
docs/introduction.mdxdocs/self-hosting/docker.mdxdocs/self-hosting/installation.mdx
…com#28832)" This reverts commit d08f4a0.
What does this PR do?
.envreferencesVisual Demo
N/A (documentation-only changes)
Mandatory Tasks
How should this be tested?
docs/introduction.mdxdocs/self-hosting/docker.mdxdocs/self-hosting/installation.mdxChecklist