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
11 changes: 11 additions & 0 deletions .changeset/adr-0046-docs-portal-description.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
"@object-ui/console": patch
---

fix(ADR-0046): docs portal shows summaries, not machine ids.

The portal listed each doc as title + its raw machine name (`showcase_index`)
— noise for the business readers docs are written for. Drop the machine id from
the reader-facing list and render the doc's `description` (ADR-0046) as a
one-line summary under the title instead. Falls back cleanly when a doc has no
description.
16 changes: 11 additions & 5 deletions apps/console/src/pages/DocsIndex.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ export default function DocsIndex() {
if (cancelled) return;
setGroups(
groupDocsByPackage(
items.map((it) => ({ name: it?.name, label: it?.label })),
items.map((it) => ({ name: it?.name, label: it?.label, description: it?.description })),
),
);
setState('ready');
Expand Down Expand Up @@ -110,11 +110,17 @@ export default function DocsIndex() {
<li key={doc.name}>
<Link
to={`/docs/${doc.name}`}
className="flex items-center gap-2 px-3 py-2 text-sm hover:bg-muted/50"
className="flex items-start gap-3 px-3 py-3 hover:bg-muted/50"
>
<BookOpen className="h-4 w-4 shrink-0 text-muted-foreground" />
<span className="font-medium">{doc.label ?? doc.name}</span>
<code className="ml-auto text-xs text-muted-foreground">{doc.name}</code>
<BookOpen className="mt-0.5 h-4 w-4 shrink-0 text-muted-foreground" />
<div className="min-w-0">
<div className="text-sm font-medium">{doc.label ?? doc.name}</div>
{doc.description ? (
<div className="mt-0.5 line-clamp-2 text-xs text-muted-foreground">
{doc.description}
</div>
) : null}
</div>
</Link>
</li>
))}
Expand Down
1 change: 1 addition & 0 deletions apps/console/src/pages/doc-groups.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
export interface DocListItem {
name: string;
label?: string;
description?: string;
}

export interface DocGroup {
Expand Down
Loading