Skip to content

docs: minor documentation formatting update#29301

Closed
thanhdatloveyou18-coder wants to merge 1 commit into
calcom:mainfrom
thanhdatloveyou18-coder:patch-1778550726
Closed

docs: minor documentation formatting update#29301
thanhdatloveyou18-coder wants to merge 1 commit into
calcom:mainfrom
thanhdatloveyou18-coder:patch-1778550726

Conversation

@thanhdatloveyou18-coder
Copy link
Copy Markdown

This PR addresses minor formatting issues and cleans up trailing whitespace to improve readability.

@github-actions
Copy link
Copy Markdown
Contributor

Welcome to Cal.diy, @thanhdatloveyou18-coder! Thanks for opening this pull request.

A few things to keep in mind:

  • This is Cal.diy, not Cal.com. Cal.diy is a community-driven, fully open-source fork of Cal.com licensed under MIT. Your changes here will be part of Cal.diy — they will not be deployed to the Cal.com production app.
  • Please review our Contributing Guidelines if you haven't already.
  • Make sure your PR title follows the Conventional Commits format.

A maintainer will review your PR soon. Thanks for contributing!

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 12, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

This pull request adds an HTML comment marker in the acknowledgements section of README.md. The change inserts three lines at lines 832-834, placing a formatting marker comment immediately after the acknowledgements bullet list. No code entities or public APIs are altered; this is a documentation-only update.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the main change as a minor documentation formatting update, which directly aligns with the changeset that adds formatting in README.md.
Description check ✅ Passed The description is related to the changeset, mentioning formatting issues and trailing whitespace cleanup that matches the documentation update in the PR.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

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

🧹 Nitpick comments (1)
README.md (1)

832-834: 💤 Low value

Inconsistency between PR description and actual changes.

The PR description states this change "removes trailing whitespace to improve readability," but the diff shows only additions (two blank lines and an HTML comment). Additionally, the HTML comment <!-- Formatting update --> appears to be meta-commentary about the PR itself rather than functional documentation content.

Recommendation

If the goal is simply formatting cleanup, consider removing these added lines entirely:

 - [Prisma](https://prisma.io/)
-
-
-<!-- Formatting update -->

If blank lines are desired for spacing, keep those but remove the non-functional comment:

 - [Prisma](https://prisma.io/)
 
 
-<!-- Formatting update -->
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 832 - 834, The PR added two blank lines and a
non-functional HTML comment "<!-- Formatting update -->" to README.md; remove
the HTML comment and either delete the added blank lines entirely or keep just
the blank lines (not the comment) so the change matches the PR description of
whitespace-only formatting; ensure the final README.md contains only the desired
spacing without meta-commentary.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@README.md`:
- Around line 832-834: The PR added two blank lines and a non-functional HTML
comment "<!-- Formatting update -->" to README.md; remove the HTML comment and
either delete the added blank lines entirely or keep just the blank lines (not
the comment) so the change matches the PR description of whitespace-only
formatting; ensure the final README.md contains only the desired spacing without
meta-commentary.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 7d588a03-bd41-47fb-ae95-418208797b92

📥 Commits

Reviewing files that changed from the base of the PR and between fb01494 and d4605bb.

📒 Files selected for processing (1)
  • README.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants