Skip to content

DX-2984: bundle Box source and docs - #244

Open
ytkimirti wants to merge 4 commits into
mainfrom
DX-2984-bundle-docs
Open

ytkimirti wants to merge 4 commits into
mainfrom
DX-2984-bundle-docs

Conversation

@ytkimirti

Copy link
Copy Markdown
Contributor

Ship Box TypeScript source and SDK documentation in the npm package so developers and coding agents can read them locally. Include the existing TypeScript SDK src/, preserving file contents and relative imports. Exclude tests and test helpers.

Fetch the Box docs into the SDK package's docs/ during packing and publishing, matching Blob and Redis's giget approach. Add a patch changeset for @upstash/box. Document the installed paths and ignore downloaded docs in git. Packing requires network access and follows the docs main branch.

Validation: Workspace build, all 1,091 unit tests, lint, and local package inspection passed. The tarball includes 6 source files and 44 documentation files; packaged source files match their repository originals and their internal imports resolve. Installing the tarball in a clean consumer and loading the ESM entry point passed. Public exports are unchanged. Live service tests were not run locally.

@linear-code

linear-code Bot commented Sep 18, 2026

Copy link
Copy Markdown

DX-2984

This branch has not been deployed

No deployments
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.

1 participant