docs(js): Improve TS SDK docs - #311
Conversation
ef1e084 to
f2442d2
Compare
f2442d2 to
de66585
Compare
de66585 to
be42bd6
Compare
be42bd6 to
a2cd67e
Compare
There was a problem hiding this comment.
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
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.
a2cd67e to
e95007c
Compare
e95007c to
6fc743c
Compare
There was a problem hiding this comment.
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
Open (3)
Resolved since last review (1)
Signed-off-by: aabedraba <abdallah@unikraft.com>
c0e69ea to
a62a96a
Compare
There was a problem hiding this comment.
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
Open (1)
Resolved since last review (3)
Files not reviewed (1)
- pnpm-lock.yaml: Generated file
|
@nderjung ready to merge. |
nderjung
left a comment
There was a problem hiding this comment.
Thanks!
Reviewed-by: Alexander Jung alex@unikraft.com
Approved-by: Alexander Jung alex@unikraft.com



Uh oh!
There was an error while loading. Please reload this page.