Skip to content

feat(console): DocPage resolves docs package-scoped (ADR-0048 — prefix optional) #1701

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
Jun 14, 2026
Merged

feat(console): DocPage resolves docs package-scoped (ADR-0048 — prefix optional) #1701

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
11 changes: 8 additions & 3 deletions apps/console/src/pages/DocPage.tsx
View file
Open in desktop
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