Skip to content

docs(js): Improve TS SDK docs - #311

Merged
nderjung merged 1 commit into
prod-stagingfrom
aabedraba/js-sdk
Sep 25, 2026
Merged

nderjung merged 1 commit into
prod-stagingfrom
aabedraba/js-sdk

Conversation

@aabedraba

@aabedraba aabedraba commented Sep 24, 2026 •

Copy link
Copy Markdown
Contributor
  • Breaking up 1 single README into multiple sections sections for the JS SDK
  • Top level Sandbox page
  • Improving table view so it doesn't wrap code values

@aabedraba
aabedraba temporarily deployed to pull-requests September 24, 2026 18:08 — with GitHub Actions Inactive
@aabedraba aabedraba changed the title aabedraba/js sdk docs(js): Improve TS SDK docs Sep 24, 2026
Comment thread pages/sdks/js/client.mdx
Comment thread pages/sdks/js/client.mdx
Comment thread pages/sdks/js/sandboxes.mdx Outdated
Comment thread pages/sdks/js.mdx
Comment thread pages/sdks/js.mdx
@aabedraba
aabedraba changed the base branch from prod-staging to docs/merge-guides-tutorials September 24, 2026 18:10
@aabedraba
aabedraba added this pull request to stack #312 September 24, 2026 18:10
@github-actions
github-actions Bot temporarily deployed to pull-requests September 24, 2026 18:11 Inactive
@aabedraba
aabedraba temporarily deployed to pull-requests September 24, 2026 18:11 — with GitHub Actions Inactive
@github-actions
github-actions Bot temporarily deployed to pull-requests September 24, 2026 18:15 Inactive
@aabedraba
aabedraba temporarily deployed to pull-requests September 24, 2026 18:42 — with GitHub Actions Inactive
@aabedraba
aabedraba requested a lite review from Copilot September 24, 2026 18:42
@github-actions
github-actions Bot temporarily deployed to pull-requests September 24, 2026 18:43 Inactive
@aabedraba
aabedraba temporarily deployed to pull-requests September 24, 2026 18:43 — with GitHub Actions Inactive
@github-actions
github-actions Bot temporarily deployed to pull-requests September 24, 2026 18:45 Inactive
@aabedraba
aabedraba temporarily deployed to pull-requests September 24, 2026 18:45 — with GitHub Actions Inactive

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟡 Changes recommended

Resolve the documented example errors, restore the omitted method, and fix deployed navigation active-state matching.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 1 Medium severity

Open (1)
What changed in this PR

This PR restructures the JavaScript SDK documentation, adds sandbox guidance, and updates navigation and tooling.

Changes:

  • Splits the SDK documentation into focused reference and sandbox pages.
  • Adds grouped navigation and reorganizes guides.
  • Updates Zudoku, dependencies, styling, and Vale vocabulary.
File Summary
zudoku.config.tsx Updates navigation and table styling.
src/​TopNavMenus.tsx Adds grouped navigation; deployed active-path matching needs correction.
scripts/​update_zudoku_guides.py Updates generated guide navigation.
pnpm-lock.yaml Locks dependency updates.
pages/​use-cases/​sandboxes.mdx Updates the SDK link.
pages/​sdks/​overview.mdx Updates the sandbox link.
pages/​sdks/​js/​sandboxes/​files.mdx Documents filesystem operations; the example lacks an fs definition.
pages/​sdks/​js/​sandboxes/​connect.mdx Documents sandbox reconnection and listing.
pages/​sdks/​js/​sandboxes/​configuration.mdx Documents sandbox configuration.
pages/​sdks/​js/​sandboxes/​commands.mdx Documents sandbox commands.
pages/​sdks/​js/​sandboxes.mdx Adds the sandbox overview.
pages/​sdks/​js/​resources.mdx Documents resources and APIs; the method table omits ukc.users.add.
pages/​sdks/​js/​metros.mdx Documents metro scopes and fan-out; one example uses undefined use.
pages/​sdks/​js/​errors.mdx Documents SDK errors and waits.
pages/​sdks/​js/​client.mdx Documents client configuration and runtime behavior.
pages/​sdks/​js.mdx Adds the SDK landing page.
pages/​introduction.mdx Disables Stepper TOC generation.
pages/​guides/​overview.mdx Reorganizes tutorials and example apps.
package.json Updates Zudoku and React type dependencies.
.vale/​styles/​config/​vocabularies/​Unikraft/​accept.txt Accepts the ESM term.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread pages/sdks/js/sandboxes/files.mdx Outdated
@github-actions
github-actions Bot temporarily deployed to pull-requests September 24, 2026 18:48 Inactive
@aabedraba
aabedraba temporarily deployed to pull-requests September 24, 2026 18:57 — with GitHub Actions Inactive
@github-actions
github-actions Bot temporarily deployed to pull-requests September 24, 2026 19:00 Inactive
@aabedraba
aabedraba temporarily deployed to pull-requests September 24, 2026 19:02 — with GitHub Actions Inactive
@aabedraba
aabedraba removed this pull request from stack #312 September 24, 2026 19:05
@github-actions
github-actions Bot temporarily deployed to pull-requests September 24, 2026 19:05 Inactive
@aabedraba
aabedraba changed the base branch from docs/merge-guides-tutorials to prod-staging September 24, 2026 19:05
@aabedraba
aabedraba requested a review from nderjung September 24, 2026 19:05
@aabedraba
aabedraba temporarily deployed to pull-requests September 24, 2026 22:52 — with GitHub Actions Inactive
@github-actions
github-actions Bot temporarily deployed to pull-requests September 24, 2026 22:55 Inactive
@danielvallance
danielvallance requested a lite review from Copilot September 25, 2026 09:18

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟡 Changes recommended

Unresolved documentation inaccuracies, cleanup guidance, and table wrapping behavior remain.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 1 High severity · 1 Medium severity · 1 Low severity

Open (3)
Resolved since last review (1)

Comment thread pages/sdks/js/sandboxes/configuration.mdx Outdated
Comment thread zudoku.config.tsx
Comment thread pages/sdks/js/errors.mdx Outdated
Signed-off-by: aabedraba <abdallah@unikraft.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟡 Changes recommended

Unresolved navigation and documentation example issues remain.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 1 Medium severity

Open (1)
Resolved since last review (3)
Files not reviewed (1)
  • pnpm-lock.yaml: Generated file

Comment thread src/TopNavMenus.tsx
@aabedraba

Copy link
Copy Markdown
Contributor Author

@nderjung ready to merge.

@nderjung nderjung left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

Reviewed-by: Alexander Jung alex@unikraft.com
Approved-by: Alexander Jung alex@unikraft.com

@nderjung
nderjung merged commit 314e688 into prod-staging Sep 25, 2026
9 checks passed
@nderjung
nderjung deleted the aabedraba/js-sdk branch September 25, 2026 23:39
@nderjung
nderjung deployed to pull-requests September 25, 2026 23:39 — with GitHub Actions Active

This branch was successfully deployed

1 active deployment
pull-requests — a62a96ab Deployed Sep 25, 2026 by nderjung via cleanup #789
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants