You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
chore: [docs] upgrade fumadocs, next and zod in the docs site - #996
Upgrade fumadocs-typescript to 5.6.0, fumadocs-core and fumadocs-ui to 16.17.9, fumadocs-mdx to 15.4.10, next to 16.4.3 and zod to ^4.6.7, and remove the unused fumadocs-docgen. Each props row now shows a short type, and the expanded row shows the full type.
Render the highlighted type, typeDescription and default nodes in TypeTable, and let the MDX code component pass them through. These ship with the upgrade, since without them every row shows [object Object].
Build the LLM text tables with typeTableToMarkdown. 5.x passes tags as an array, so the old code lost the defaults.
Move the generator to lib/type-table.ts, so the pages and the LLM text use one generator and transform. The transform keeps the written type for literal unions, aliases, *Ref and children, and shows function for callbacks.
Add tsconfig.props.json with types: ["react"]. fumadocs-typescript 5 runs TypeScript 7, which loads no @types package by default, so React.* types showed as any.
The docs app updates Fumadocs, Next.js, and Zod dependencies. It moves type-table generator configuration into a shared module and passes the generator and transform to the docs and AI processors. The remark plugin converts generated type-table data to Markdown. The type-table UI changes how it displays types and defaults, and the MDX Code component handles non-string children directly.
Sequence Diagram(s)
sequenceDiagram
participant SourceConfig
participant remarkAutoTypeTable
participant generator
participant transform
participant remarkTypeTableToMd
participant typeTableToMarkdown
SourceConfig->>remarkAutoTypeTable: Register generator and transform options
remarkAutoTypeTable->>generator: Generate type-table data
generator->>transform: Transform property entries
generator->>remarkTypeTableToMd: Provide generated TypeTable data
remarkTypeTableToMd->>typeTableToMarkdown: Convert normalized entries to Markdown
Loading
Possibly related issues
raystack/apsara#990 — The changes update the docs-site dependencies and adapt TypeTable behavior described by the issue.
raystack/apsara#988 — The added props TypeScript configuration sets React types for type generation; the broader TypeScript migration is not included.
Suggested reviewers:rohanchkrabrty
Priority: Normal
Merge Risk: Minimal · previous review 73ca7
The dependency and type-table updates have no demonstrated merge-blocking defect. Whether expanded types omit optionality remains unverified.
Pre-merge checks: 4 · 1
Failed checks: 1 warning
Check name
Status
Explanation
Resolution
Docstring Coverage
Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documenta…
Write docstrings for the functions missing them to satisfy the coverage threshold.
Passed checks: 4 passed
Check name
Status
Explanation
Title check
The title clearly identifies the main dependency upgrades in the docs site. It is concise and related to the changeset.
Description check
The description accurately covers the dependency upgrades, TypeTable rendering changes, shared generator, Markdown conversion, and TypeScript configuration changes.
Linked Issues check
Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check
Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage
Explanation
Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 2 functions across 6 files. (4 skipped: 4 unsupported.)
Resolution
Write docstrings for the functions missing them to satisfy the coverage threshold.
Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
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.
Unverified finding
We couldn't verify this from the code. It is shown for review, not as a verified issue.
The expanded row no longer appends | undefined for optional props. If Fumadocs supplies a typeDescription that omits optionality, the displayed full type now misstates that prop's signature.
The expanded type table presents an optional prop as having a non-undefined type.
This can occur when: An optional prop has a full typeDescription node such as string rather than string | undefined.
Review info
Run configuration
Source mode: Auto
Repository: Unavailable
Branch: Unavailable
File: No configuration file from this repository applied
Commit: Unavailable
Layers: Organization UI
Review profile: CHILL
Plan: Advanced
Run ID: c506eec3-2d3b-4cb1-96bd-59bf6c032dec
Commits
Reviewing files that changed from the base of the PR and between 4ccee72 and 73ca7ae.
Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Summary
type,typeDescriptionanddefaultnodes inTypeTable, and let the MDXcodecomponent pass them through. These ship with the upgrade, since without them every row shows[object Object].typeTableToMarkdown. 5.x passestagsas an array, so the old code lost the defaults.lib/type-table.ts, so the pages and the LLM text use one generator and transform. The transform keeps the written type for literal unions, aliases,*Refandchildren, and showsfunctionfor callbacks.tsconfig.props.jsonwithtypes: ["react"]. fumadocs-typescript 5 runs TypeScript 7, which loads no@typespackage by default, soReact.*types showed asany.Part of #879