Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 12 additions & 0 deletions .changeset/adr-0048-docpage-package-scoped.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
"@object-ui/console": patch
---

ADR-0048: DocPage resolves docs package-scoped. The doc viewer at
`/apps/:appName/docs/:name` now passes the route's package segment as
`getItem('doc', name, { packageId })`, so the single-doc fetch is package-scoped
(prefer-local) on the server. Two installed packages may ship a doc with the
same bare name and each resolves within its own package — doc names no longer
need a globally-unique namespace prefix (the prefix becomes a convention, like
`page`/`dashboard`/`report`). The legacy top-level `/docs/:name` path (no
`appName`) keeps its context-free behavior.
11 changes: 8 additions & 3 deletions apps/console/src/pages/DocPage.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,9 @@ interface DocItem {
* "not found" notice — never an install-time or hard failure.
*/
export default function DocPage() {
const { name } = useParams<{ name: string }>();
// `appName` is the parent route's package-id segment
// (/apps/:appName/docs/:name); undefined on the legacy top-level /docs/:name.
const { name, appName } = useParams<{ name: string; appName?: string }>();
const navigate = useNavigate();
const adapter = useAdapter();
const [doc, setDoc] = useState<DocItem | null>(null);
Expand All @@ -47,7 +49,10 @@ export default function DocPage() {
if (!name || !adapter) return;
setState('loading');
try {
const raw: any = await adapter.getClient().meta.getItem('doc', name);
// ADR-0048 — pass the route's package so the single-doc fetch is
// package-scoped (prefer-local) on the server. With this, doc names
// need not be globally namespace-prefixed; the prefix becomes optional.
const raw: any = await adapter.getClient().meta.getItem('doc', name, appName ? { packageId: appName } : undefined);
const item = raw?.item ?? raw?.data ?? raw;
if (cancelled) return;
if (item && typeof item.content === 'string') {
Expand All @@ -73,7 +78,7 @@ export default function DocPage() {
return () => {
cancelled = true;
};
}, [name, adapter]);
}, [name, appName, adapter]);

// SPA navigation for rewritten doc-to-doc links: anchors render as
// plain <a href="/docs/...">; intercept same-app clicks so following a
Expand Down
Loading