docs: fix dead dremio/js-sdk link in DISCOVERY_SERVICE_PLAN.md#31
Conversation
The GitHub repo https://github.com/dremio/js-sdk returns 404 — the SDK's TypeScript source repository is internal and not public. Point the source-of- truth link to the public npm package @dremio/js-sdk instead, flag that the PoC parser requires the internal src/ (the npm tarball ships compiled dist/ only), and add a short section answering how external users can explore all three SKUs today (docs.dremio.com + the package's bundled .d.ts declarations). Fixes #7 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
![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: 435dc93a27
ℹ️ 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".
|
|
||
| Run it: | ||
|
|
||
| > **Note (internal-only prerequisite):** `scripts/parse_jssdk.py` requires the SDK's TypeScript source (`src/*.ts`), which is only available from Dremio's internal SDK repository. The public npm package `@dremio/js-sdk` ships compiled `dist/` output only and cannot be parsed by this script. |
There was a problem hiding this comment.
In this Run it section, the new note says the SDK source is internal-only, but the commands immediately below still tell readers to clone https://github.com/dremio/js-sdk.git, the same public 404 URL this change is meant to avoid. Anyone following the refreshed docs without Dremio-internal access still fails before parse_jssdk.py runs, so the block should use an internal checkout placeholder or be explicitly rewritten as internal-only.
Useful? React with 👍 / 👎.
Addresses Codex P2: the internal-only note still showed the public github.com/dremio/js-sdk clone URL, so a public reader would still hit the dead link. Use an <internal-js-sdk-repo> placeholder instead. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The plan doc points readers at this script, whose docstring still showed the public github.com/dremio/js-sdk 404 URL. Use the internal-repo placeholder and note the parser needs Dremio-internal SDK source (npm ships compiled dist only). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 participant
What
Fixes the dead link reported in #7.
https://github.com/dremio/js-sdkreturns 404 — the SDK's TypeScript source repository is internal to Dremio and not public. The public artifact is the npm package@dremio/js-sdk(latest0.62.1, Apache-2.0).Changes (docs only —
DISCOVERY_SERVICE_PLAN.md)scripts/parse_jssdk.pyrequires the SDK'ssrc/*.ts(internal only) — the npm tarball ships compileddist/+.d.tsdeclarations only, so the parser can't run against the package. This is why the oldgit cloneinstructions no longer work publicly..d.tstype declarations bundled in the npm package (@dremio/js-sdk/oss,/enterprise,/cloud).Notes
js-sdkreferences in diagrams/tables/checklists are left intact (they refer to the SDK by npm name and remain valid).Fixes #7
🤖 Generated with Claude Code