Skip to content

examples/byo-backend-console/README.md teaches ObjectRenderer, an export that exists nowhere in the repo #7095

Description

@os-sam

Found during the published-skills factual sweep of skills/objectui/** (ui#7094). The skill package's copies are fixed there; this site is outside that PR's file surface, so it is filed rather than edited.

The defect

examples/byo-backend-console/README.md teaches, in three separate snippets (6 occurrences at lines 63, 72, 88, 89, 107, 110):

import { AppShell, ObjectRenderer } from '@object-ui/app-shell';
// ...
Route path="/:object" element={ObjectRenderer}

ObjectRenderer does not exist anywhere in this repository. Measured at origin/main@2c3cd1b:

  • git grep ObjectRenderer packages apps examples returns 6 hits, all of them in this one README — zero in any source file.
  • Executed against the real module in the dom vitest project: Object.hasOwn(appShell, 'ObjectRenderer') is false.

The real export is ObjectView (packages/app-shell/src/views/ObjectView.tsx, re-exported from packages/app-shell/src/index.ts alongside RecordDetailView, DashboardView, PageView, ReportView). It takes objectName, so the fix is a rename in place.

Why it is worth a card

This README is the copy-paste starting point for the "bring your own backend" integration path — the exact audience with no way to tell a phantom name from a real one. The import does not resolve, so the failure is loud, but it is loud after the reader has built a router around it.

Suggested fix

Rename ObjectRenderer to ObjectView at all six sites. Check the surrounding prose for PageRenderer / DashboardRenderer while there: DashboardRenderer is a real export of @object-ui/plugin-dashboard, and PageRenderer is internal to @object-ui/components (reached through the page / app / utility / home / record registry keys, never by import) — neither comes from app-shell.

Related: ui#7094 (the sweep that found it).

Generated by Claude Code

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationdomain:devxobjectui devx stream: fix lands on .github/, scripts/ or release pipeline — devx lane cross-repofindingpm:queuepriority:p2

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions