Repository navigation
docs: Add JSDoc comments to exported types and interfaces - #886
Conversation
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
|
React Doctor found no new issues. 🎉 Reviewed by React Doctor for commit |
aXenDeveloper
changed the title
Add concise English JSDoc to the developer-facing APIs of @vitnode/core and @vitnode/blog: plugin foundations (buildPlugin, buildApiPlugin, bindApiPlugin, buildModule, buildRoute, manifests), the Content Engine, fetchers and the API registry, events, cron, queues, notifications, WebSockets, widgets, the editor adapter, routing, app configuration, TanStack entry points, server context, AutoForm and form fields, tables, UI primitives, and every symbol the MDX docs import. Every batch was fact-checked against the source. Keep JSDoc in published declarations: the shared tsconfig sets removeComments, which stripped every comment from the .d.ts files the package build emits. Fixes: - AutoFormDateTime spread its rest props after its own onChange/onBlur, so a caller's onChange replaced the handler that writes the form value. The caller's handlers now run after the form update. - Plugin dashboard widgets never reached the AdminCP in TanStack hosts. They now travel on adminNav.admin.dashboard.widgets through admin-nav.gen.ts to the dashboard screen, which also loads the plugins' widget message namespaces. Docs: fix MDX examples importing APIs that don't exist (email adapters, search indexers, captcha, ApiPluginContract), the widget component props and the blog post event note. AGENTS.md gains a JSDoc rule and describes the generated plugin API registry entry. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_016fFJwQoQUcq6FtMdeGUaHc
7741cce to
1d76100
Compare
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 1d76100fbb
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| fitNamespaceList([ | ||
| ...ADMIN_DASHBOARD_NAMESPACES, | ||
| ...widgets.flatMap(({ pluginId }) => [ | ||
| `${pluginId}.title`, | ||
| `${pluginId}.admin.dashboard.widgets`, | ||
| ]), | ||
| ]), |
There was a problem hiding this comment.
When 15 or more plugins contribute dashboard widgets, fitNamespaceList cannot reduce this list below the API limit: after coarsening, each plugin still contributes one unique root namespace, plus admin and core, yielding at least 17 entries. RouteMessages then requests those namespaces, while validateIntlInput rejects any request exceeding MAX_NAMESPACES (16), so the AdminCP dashboard fails to render for such installations. Split the plugin namespaces across requests/providers or otherwise ensure the final list actually respects the cap.
Useful? React with 👍 / 👎.
2 participants
Description
What?
Added comprehensive JSDoc documentation comments to hundreds of exported types, interfaces, and functions throughout the codebase. This includes:
The documentation follows the existing style with concise, single-line or multi-line descriptions explaining the purpose and usage of each exported symbol.
Why?
Improved IDE autocomplete and inline documentation for developers using the VitNode framework. JSDoc comments provide:
This change affects no runtime behavior and is purely additive documentation.
Test Plan
N/A - Documentation-only changes with no functional impact.
https://claude.ai/code/session_016fFJwQoQUcq6FtMdeGUaHc