docs(dashboard): Updating inline docblocks #3714

HouseinIsProgramming · 2025-08-01T08:39:50Z

Description

This PR updates the jsDocs in exported interfaces of dashboard

📌 Always:

I have set a clear title
My PR is small and contains a single feature
I have checked my own PR

👍 Most of the time:

I have added or updated test cases
I have updated the README if needed

Summary by CodeRabbit

Documentation
- Updated version annotations in the documentation for login page extension interfaces.
- Enhanced descriptions for custom form components and detail form customization.
- Added detailed documentation for bulk actions, navigation sections, and dashboard routes.
- Clarified purpose and usage of various dashboard extension interfaces and properties.
- Removed developer preview status labels and added documentation page tags across multiple dashboard extension types.

vercel · 2025-08-01T08:39:55Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
docs	✅ Ready (Inspect)	Visit Preview	Aug 1, 2025 11:39am

coderabbitai · 2025-08-01T08:39:58Z

Caution

Review failed

The pull request is closed.

Walkthrough

Documentation comments were added or enhanced across multiple dashboard extension API TypeScript interfaces, clarifying the purpose and usage of properties and interfaces related to login extensions, custom form components, detail forms, data tables, navigation, layout, widgets, and dashboard extensions. No code or type signatures were changed.

Changes

Cohort / File(s)	Change Summary
Login Extension API Docs `packages/dashboard/src/lib/framework/extension-api/types/login.ts`	Removed "Status: Developer Preview" annotation; updated `@since` tags from "3.3.0" to "3.4.0"; added `@docsPage Login` tag. No code or type changes.
Dashboard Extension API Documentation Enhancements `packages/dashboard/src/lib/framework/extension-api/extension-api-types.ts`	Refined JSDoc comment for `customFormComponents` property; added JSDoc for `detailForms` property. No signature changes.
Data Table Types Documentation `packages/dashboard/src/lib/framework/extension-api/types/data-table.ts`	Added `@docsPage DataTable` tag; enhanced JSDoc comments for `BulkAction` properties `order` and `component`; removed "Status: Developer Preview" annotation. No signature changes.
Detail Forms Types Documentation `packages/dashboard/src/lib/framework/extension-api/types/detail-forms.ts`	Added `@docsPage DetailForms` tag; added descriptive JSDoc comments for `DashboardDetailFormExtensionDefinition` and its `extendDetailDocument` property. No structural changes.
Form Components Types Documentation `packages/dashboard/src/lib/framework/extension-api/types/form-components.ts`	Added detailed JSDoc comments to `DashboardCustomFormComponent` properties `id` and `component`; added `@docsPage FormComponents` tag. No signature changes.
Navigation Types Documentation `packages/dashboard/src/lib/framework/extension-api/types/navigation.ts`	Added detailed JSDoc comments to `DashboardRouteDefinition` and `DashboardNavSectionDefinition` interfaces and their properties. No signature changes.
Layout Types Documentation `packages/dashboard/src/lib/framework/extension-api/types/layout.ts`	Removed "Status: Developer Preview" annotation; added `@docsPage Layout` tag to `DashboardActionBarItem`, `PageBlockLocation`, and `DashboardPageBlockDefinition`. No code changes.
Widgets Types Documentation `packages/dashboard/src/lib/framework/extension-api/types/widgets.ts`	Removed "Status: Developer Preview" annotation from `DashboardBaseWidgetProps` and `DashboardWidgetInstance`. No other changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

feat(dashboard): Add customizable login extensions API #3704: Introduces the login extension API implementation including new interfaces, hooks, and login form integration; related to the login extension interfaces documented in this PR.

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 28d2add and 409ec90.

📒 Files selected for processing (7)

packages/dashboard/src/lib/framework/extension-api/types/data-table.ts (2 hunks)
packages/dashboard/src/lib/framework/extension-api/types/detail-forms.ts (4 hunks)
packages/dashboard/src/lib/framework/extension-api/types/form-components.ts (2 hunks)
packages/dashboard/src/lib/framework/extension-api/types/layout.ts (3 hunks)
packages/dashboard/src/lib/framework/extension-api/types/login.ts (5 hunks)
packages/dashboard/src/lib/framework/extension-api/types/navigation.ts (1 hunks)
packages/dashboard/src/lib/framework/extension-api/types/widgets.ts (0 hunks)

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

🪧 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 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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 17c27ff and d750a7d.

📒 Files selected for processing (1)

packages/dashboard/src/lib/framework/extension-api/types/login.ts (5 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

packages/dashboard/src/**/*.{ts,tsx}

📄 CodeRabbit Inference Engine (.cursor/rules/dashboard.mdc)

packages/dashboard/src/**/*.{ts,tsx}: Use TanStack Query (useQuery or useMutation) for data fetching; do not use Apollo Client.
When creating useQuery calls, follow the provided pattern: import { api } from '@/graphql/api.js'; import { graphql } from '@/graphql/graphql.js'; use useQuery with queryKey, staleTime, and queryFn using api.query.
When performing mutations, follow the provided useMutation pattern: use graphql() for the mutation document, api.mutate for mutationFn, and do not pass variables at declaration.

Files:

packages/dashboard/src/lib/framework/extension-api/types/login.ts

packages/dashboard/src/**/*.{tsx,ts}

📄 CodeRabbit Inference Engine (.cursor/rules/dashboard.mdc)

React component props objects should be typed as Readonly<...>.

Files:

packages/dashboard/src/lib/framework/extension-api/types/login.ts

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (20)

GitHub Check: e2e tests (22.x, postgres)
GitHub Check: codegen / codegen
GitHub Check: build (20.x)
GitHub Check: build (24.x)
GitHub Check: build (22.x)
GitHub Check: unit tests (22.x)
GitHub Check: publish_install (windows-latest, 24.x)
GitHub Check: publish_install (windows-latest, 22.x)
GitHub Check: publish_install (ubuntu-latest, 22.x)
GitHub Check: publish_install (ubuntu-latest, 24.x)
GitHub Check: publish_install (macos-latest, 24.x)
GitHub Check: publish_install (macos-latest, 20.x)
GitHub Check: publish_install (windows-latest, 22.x)
GitHub Check: publish_install (windows-latest, 24.x)
GitHub Check: publish_install (ubuntu-latest, 24.x)
GitHub Check: publish_install (windows-latest, 20.x)
GitHub Check: publish_install (macos-latest, 22.x)
GitHub Check: publish_install (ubuntu-latest, 22.x)
GitHub Check: publish_install (ubuntu-latest, 20.x)
GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (4)

packages/dashboard/src/lib/framework/extension-api/types/login.ts (4)

10-10: Version bump acknowledged – looks consistent

The @since tag has been updated to 3.4.0. No issues detected.

27-27: Version bump acknowledged – looks consistent

Documentation correctly reflects 3.4.0.

44-44: Version bump acknowledged – looks consistent

Change is purely doc-comment; implementation remains untouched.

61-61: Version bump acknowledged – looks consistent

No further action required.

packages/dashboard/src/lib/framework/extension-api/types/login.ts

…tailForms

michaelbromley

Some things to add. Also make sure to add @since 3.4.0 to all interfaces & types if they don't have it already

packages/dashboard/src/lib/framework/extension-api/types/detail-forms.ts

packages/dashboard/src/lib/framework/extension-api/types/data-table.ts

packages/dashboard/src/lib/framework/extension-api/types/form-components.ts

packages/dashboard/src/lib/framework/extension-api/types/login.ts

packages/dashboard/src/lib/framework/extension-api/types/navigation.ts

sonarqubecloud · 2025-08-01T11:38:58Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

docs(dashboard): Correct "since" version in jsdoc

d750a7d

coderabbitai bot reviewed Aug 1, 2025

View reviewed changes

packages/dashboard/src/lib/framework/extension-api/types/login.ts Show resolved Hide resolved

HouseinIsProgramming marked this pull request as draft August 1, 2025 08:50

HouseinIsProgramming added 3 commits August 1, 2025 10:59

docs(dashboard): Simplify customFormComponent jsDoc and add one to de…

f5d0441

…tailForms

docs(dashboard): Add annotations to extendDetailDocument

100e838

docs(dashboard): Add missing jsDocs for all types and sub-types

28d2add

HouseinIsProgramming marked this pull request as ready for review August 1, 2025 09:32

vercel bot deployed to Preview August 1, 2025 09:33 View deployment

michaelbromley requested changes Aug 1, 2025

View reviewed changes

dlhck changed the title ~~Updating jsDocs in new dashboard~~ docs(dashboard): Updating inline docblocks Aug 1, 2025

docs(dashboard): More detail and missing tags

409ec90

michaelbromley merged commit 3688fda into minor Aug 1, 2025
32 of 37 checks passed

michaelbromley deleted the jsdoc-and-doc-updates branch August 1, 2025 11:38

vercel bot deployed to Preview August 1, 2025 11:39 View deployment

github-actions bot locked and limited conversation to collaborators Aug 1, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

docs(dashboard): Updating inline docblocks #3714

docs(dashboard): Updating inline docblocks #3714

Uh oh!

HouseinIsProgramming commented Aug 1, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

vercel bot commented Aug 1, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Aug 1, 2025 •

edited

Loading

Review failed

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

michaelbromley left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud bot commented Aug 1, 2025

Uh oh!

Uh oh!

Uh oh!

docs(dashboard): Updating inline docblocks #3714

docs(dashboard): Updating inline docblocks #3714

Uh oh!

Conversation

HouseinIsProgramming commented Aug 1, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Summary by CodeRabbit

Uh oh!

vercel bot commented Aug 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Aug 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review failed

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

michaelbromley left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud bot commented Aug 1, 2025

Quality Gate passed

Uh oh!

Uh oh!

HouseinIsProgramming commented Aug 1, 2025 •

edited by coderabbitai bot

Loading

vercel bot commented Aug 1, 2025 •

edited

Loading

coderabbitai bot commented Aug 1, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)