fix(ADR-0046): docs portal shows summaries, not machine ids#1692
Merged
Conversation
The portal listed each doc as title + its raw machine name (showcase_index) — noise for the business readers docs are for. Drop the machine id from the reader-facing list; render the doc's `description` (one-line summary) under the title instead (graceful when absent). Verified live against a description-serving backend: portal shows titles + gray summaries, no machine ids. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub. |
Contributor
✅ Console Performance Budget
📦 Bundle Size Report
Size Limits
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
The docs portal listed each doc as title + its raw machine name (
showcase_index) on the right. That id is a URL/link key for authors — noise for the business readers docs are written for.Change
description(ADR-0046, new field) as a one-line summary under the title. Graceful fallback when a doc has no description.DocListItemcarriesdescription; the portal fetch maps it through.Verification (live, browser)
Portal against a description-serving backend (companion framework PR objectstack-ai/objectstack#1811):
SHOWCASEgroup → Documentation Guide + "The authoring rules every package doc must follow — …" and Showcase + "Overview of the showcase package and the docs-as-metadata feature it demonstrates."Screenshot captured.
Stack
Pairs with framework#1811 (
descriptionfield +/meta/doclist carries it).🤖 Generated with Claude Code