Skip to content

docs(skills): name the objectui upload packages after the providers fold #30683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
os-zhuang merged 1 commit into from
Nov 6, 2026
Merged

docs(skills): name the objectui upload packages after the providers fold #30683

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .changeset/30559-objectui-upload-guide-packages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
'@objectstack/skills': patch
---

docs(skills): the objectui project-setup guide names where uploads live now that `@object-ui/providers` is gone

Clause-②: no
Metadata-protocol: none

- **Before.** `objectui/guides/project-setup.md` sent a third-party app to `@object-ui/providers` for `UploadProvider` / `useUpload`, in the provider-stack list and in the decision matrix. That package is retired and gets no further release.
- **Now.** `UploadProvider` / `useUpload` come from `@object-ui/fields`; the ObjectStack storage adapter `createObjectStackUploadAdapter` comes from `@object-ui/data-objectstack`; the `UploadAdapter` / `UploadOptions` / `UploadResult` contract is `@object-ui/types`'s, re-exported by `@object-ui/fields`.
- The troubleshooting section drops two monorepo-only tips (the Turbo cache block and the "downstream packages need built `dist/`" line), which a third-party app consuming published packages never needs.
- No schema, key or behaviour changes.
13 changes: 5 additions & 8 deletions skills/objectui/guides/project-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,8 +246,10 @@ The provider stack for a third-party app comes from the packages that read it:
`auto` / `light` / `dark` mode.
- `MetadataProvider` / `useMetadata` (`@object-ui/app-shell`) — apps / objects /
dashboards / pages metadata from the API.
- `UploadProvider` / `useUpload` (`@object-ui/providers`) — the upload adapter the
file and image fields upload through.
- `UploadProvider` / `useUpload` (`@object-ui/fields`) — the adapter file and image
fields upload through; `createObjectStackUploadAdapter`
(`@object-ui/data-objectstack`) is ObjectStack's. Its contract `UploadAdapter` /
`UploadOptions` / `UploadResult` is `@object-ui/types`'s; `fields` re-exports it.

```tsx
import { SchemaRendererProvider, ThemeProvider } from '@object-ui/react';
Expand Down Expand Up @@ -304,7 +306,7 @@ a private workspace demo app, not a published package.
|------|-----|
| Bare renderer in existing app | `@object-ui/react` |
| Need the data-source / theme providers | `SchemaRendererProvider`, `ThemeProvider` from `@object-ui/react` |
| Need file / image uploads | + `@object-ui/providers` (`UploadProvider`) |
| Need file / image uploads | + `@object-ui/fields` (`UploadProvider`), `@object-ui/data-objectstack` (adapter) |
| Need shell + object/dashboard/page/record views | + `@object-ui/app-shell` |
| Need full admin console (sidebar, system hub, navigation) | study `apps/console` patterns |
| Need a CLI-driven dev server | `@object-ui/cli` (`objectui dev`) |
Expand Down Expand Up @@ -337,13 +339,8 @@ Access in code: `import.meta.env.VITE_API_BASE_URL`

### Module not found errors
- Run `pnpm install` to ensure workspace links are resolved
- Run `pnpm build` — downstream packages need built `dist/` directories
- Check `tsconfig.json` path aliases match project structure

### Turbo cache issues
- `pnpm turbo run build --force` to bypass cache
- Delete `.turbo/` directory for clean state

### Vite HMR not working
- Check `vite.config.ts` has `react()` plugin
- Ensure file extensions are `.tsx` not `.jsx` when using TypeScript
Loading