[TOO-314] Tool documentation auto generation tool and replacing hardcode mdx for component based one #705
Conversation
…ode mdx for component based one
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
app/_components/toolkit-docs/components/AvailableToolsTable.tsx
Outdated
Show resolved
Hide resolved
app/_components/toolkit-docs/components/documentation-chunk-renderer.tsx
Show resolved
Hide resolved
app/_components/toolkit-docs/components/AvailableToolsTable.tsx
Outdated
Show resolved
Hide resolved
| }: ToolkitHeaderProps): React.ReactElement { | ||
| // Icon comes from the JSON metadata - the source of truth | ||
| const iconUrl = metadata.iconUrl; | ||
| const packageName = getPackageName(id); |
There was a problem hiding this comment.
Inconsistent package name generation across components
Medium Severity
Two different functions generate package names with different logic: getPackageName (used in toolkit-header.tsx for PyPI badges) has special handling for "Api" suffixes, while buildPipPackageName (used in toolkit-page.tsx for footer) just normalizes non-alphanumeric characters. For a toolkit like "SlackApi", getPackageName produces "arcade_slack_api" but buildPipPackageName produces "arcade_slackapi" — causing the header badges to link to a different package than the footer references.
Additional Locations (2)
| - name: Install pnpm | ||
| uses: pnpm/action-setup@v4 | ||
| with: | ||
| version: 9 |
There was a problem hiding this comment.
Workflow pnpm setup order prevents cache from working
Medium Severity
The actions/setup-node action with cache: pnpm is called before pnpm/action-setup. According to the pnpm/action-setup documentation, pnpm must be installed first for the Node.js setup action to properly configure caching. With the current order, actions/setup-node attempts to determine the pnpm store path for caching before pnpm is available, which could cause caching to silently fail or produce incorrect cache paths.
Changed build script to run toolkit-markdown BEFORE next build instead of using postbuild hook. This ensures markdown files exist before static page generation and makes the build process more reliable in Vercel. Build order: 1. toolkit-markdown - generate MD files 2. next build - build app (uses MD files) 3. custompagefind - index content 4. next-sitemap - generate sitemap
| ): void { | ||
| event.stopPropagation(); | ||
| onToggleSelection?.(toolName); | ||
| } |
There was a problem hiding this comment.
Exported function not used in component
Low Severity
The handleSelectionButtonClick function is exported and tested but not used within the component. The SelectionCell component at lines 314-320 uses inline handlers (onChange={() => onToggleSelection?.(toolName)} and onClick={(event) => event.stopPropagation()}) instead of this function. This creates duplicate logic between the exported utility and the actual implementation.
| isSelected = false, | ||
| showSelection = false, | ||
| onToggleSelection, | ||
| }: ToolSectionProps) { |
There was a problem hiding this comment.
Required prop toolkitId is never used
Low Severity
toolkitId is defined as a required property in ToolSectionProps and is passed by callers (line 732 in toolkit-page.tsx), but the ToolSection component never destructures or uses it. The prop is silently ignored, adding unnecessary API surface.
Additional Locations (1)
|
|
||
| return <PostHogProvider client={posthog}>{children}</PostHogProvider>; | ||
| return ( | ||
| <PostHogProvider client={isEnabled ? posthog : createNoopPosthogClient()}> |
There was a problem hiding this comment.
No-op PostHog client recreated on every render
Low Severity
The createNoopPosthogClient() function is called on every render when isEnabled is false, creating a new object each time. This new client reference is passed to PostHogProvider, which may cause unnecessary re-renders in all child components that consume the PostHog context via usePostHog(). The no-op client could be defined as a module-level constant or memoized with useMemo.
Additional Locations (1)
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.
| ? `${id.slice(0, -3)}_api` | ||
| : id; | ||
| return `${GITHUB_ORG_URL}/${GITHUB_REPO_PREFIX}${repoId}`; | ||
| } |
There was a problem hiding this comment.
Unused exported function adds dead code
Low Severity
The getGitHubRepoUrl function is exported but never imported or called anywhere in the codebase. It's only referenced in its own definition and re-exported via index.ts. This is dead code that adds maintenance burden without providing value. Similarly, ARCADE_DASHBOARD constant on line 41 is exported but never used.
Note
Medium Risk
Moderate risk: introduces a large new UI surface and new server routes that load data/markdown from disk, which could affect routing, performance, and content correctness across docs pages.
Overview
Introduces a new
toolkit-docscomponent suite that renders toolkit integration pages from generateddata/toolkits/*.json, including a searchable/paginated tools table, per-tool sections (params/auth/secrets/output), dynamic code examples, and page-level actions (copy generated markdown, edit JSON on GitHub).Upgrades the scope calculator (
ScopePicker) to support controlled selection, secret requirements, pagination, and copy/export (names, scopes, secrets, JSON) and wires selection into the new toolkit page UI.Adds backend support and automation: a
GET /api/toolkit-data/[toolkitId]endpoint + filesystem loader/helpers for toolkit JSON/index/static params, extends/api/markdown/*to serve generated toolkit markdown frompublic/toolkit-markdown/<category>/<toolkit>.mdwith MDX fallback, and adds a GitHub Action to regenerate toolkit docs after Porter deploys (opening a PR when outputs change). Also adjusts dashboard URL handling, quiets PostHog when disabled, and updates ignores/editor watcher settings for repo size.Written by Cursor Bugbot for commit 95f5529. This will update automatically on new commits. Configure here.