docs: Document app.controller.ts

[akamabu]

Documents apps/api/v2/src/app.controller.ts module purpose and public usage context

[github-actions]

Welcome to Cal.diy, @akamabu! 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!

[github-actions]

Hey there and thank you for opening this pull request! 👋🏼

We require pull request titles to follow the Conventional Commits specification and it looks like your proposed title needs to be adjusted.

Details:

Unknown release type "Docs" found in pull request title "Docs: Document app.controller.ts". 

Available types:
 - feat: A new feature
 - fix: A bug fix
 - docs: Documentation only changes
 - style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
 - refactor: A code change that neither fixes a bug nor adds a feature
 - perf: A code change that improves performance
 - test: Adding missing tests or correcting existing tests
 - build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
 - ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
 - chore: Other changes that don't modify src or test files
 - revert: Reverts a previous commit

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request adds a single-line module documentation comment to the top of the app controller file in apps/api/v2/src/app.controller.ts. The comment describes the module purpose and public usage context. No runtime logic, controller behavior, or public API declarations were changed.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description check	✅ Passed	The description accurately documents that the PR adds module purpose and public usage context documentation to the app.controller.ts file, matching the changeset.
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.
Title check	✅ Passed	The title 'docs: Document app.controller.ts' directly and specifically describes the main change: adding documentation to the app.controller.ts file, which aligns perfectly with the changeset.

_{✏️ 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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 1

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

Inline comments:
In `@apps/api/v2/src/app.controller.ts`:
- Line 1: The top-of-file comment in app.controller.ts is self-referential;
replace it with a concise "why" comment that explains the controller's purpose
and intent (e.g., why this controller exists, what responsibility it centralizes
such as handling API v2 routing/versioning, request validation, or
orchestration) rather than restating the file name. Update the header comment
above the AppController class (or the exported controller symbol) to a short
rationale that helps maintainers understand design intent and scope.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: e93777e1-ccdc-4284-9855-a2c28b47fdb4

📥 Commits

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

📒 Files selected for processing (1)

• apps/api/v2/src/app.controller.ts

[coderabbitai]

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Use a why-focused module comment instead of a self-referential statement.

This comment describes that documentation was added, but not the module’s purpose/intent for maintainers. Replace it with a brief “why this controller exists” note.

Suggested edit

-/** Documents apps/api/v2/src/app.controller.ts module purpose and public usage context */
+/** Exposes a version-neutral health endpoint used by platform probes and uptime checks. */

As per coding guidelines, "Only add code comments that explain why, not what" and "Never add comments that simply restate what the code does".

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	/** Documents apps/api/v2/src/app.controller.ts module purpose and public usage context */
	/** Exposes a version-neutral health endpoint used by platform probes and uptime checks. */

🤖 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 `@apps/api/v2/src/app.controller.ts` at line 1, The top-of-file comment in
app.controller.ts is self-referential; replace it with a concise "why" comment
that explains the controller's purpose and intent (e.g., why this controller
exists, what responsibility it centralizes such as handling API v2
routing/versioning, request validation, or orchestration) rather than restating
the file name. Update the header comment above the AppController class (or the
exported controller symbol) to a short rationale that helps maintainers
understand design intent and scope.