diff --git a/.changeset/adr-0046-docs-portal-description.md b/.changeset/adr-0046-docs-portal-description.md new file mode 100644 index 000000000..5570016a9 --- /dev/null +++ b/.changeset/adr-0046-docs-portal-description.md @@ -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. diff --git a/apps/console/src/pages/DocsIndex.tsx b/apps/console/src/pages/DocsIndex.tsx index 566c34280..b649ad96a 100644 --- a/apps/console/src/pages/DocsIndex.tsx +++ b/apps/console/src/pages/DocsIndex.tsx @@ -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'); @@ -110,11 +110,17 @@ export default function DocsIndex() {
{doc.name}
+