⚓ Refresh glossary categories and doc card formatting#2411
Conversation
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds a custom DocCard theme override so generated docs index cards can display rich descriptions sourced from doc/category metadata, reducing duplicate explanatory text on landing pages.
Changes:
- Introduces a custom
@theme/DocCardimplementation + styling that renders an optional description line on cards. - Adds category-level descriptions (Fundamentals + Hubble bronze/silver/gold) via
_category_.json. - Removes duplicated inline bronze/silver/gold explanations from the Hubble data dictionary index page.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| src/theme/DocCard/styles.module.scss | Adds card styling and a clamped description block. |
| src/theme/DocCard/index.tsx | Implements custom DocCard rendering with descriptions for links/categories. |
| docs/learn/fundamentals/transactions/category.json | Adds category label/link and a description for index cards. |
| docs/learn/fundamentals/stellar-data-structures/category.json | Adds category label/link and a description for index cards. |
| docs/learn/fundamentals/data-format/category.json | Adds category label/link and a description for index cards. |
| docs/learn/fundamentals/contract-development/category.json | Adds category label/link and a description for index cards. |
| docs/data/analytics/hubble/data-catalog/data-dictionary/silver/category.json | Adds Hubble “silver” description for card metadata. |
| docs/data/analytics/hubble/data-catalog/data-dictionary/gold/category.json | Adds Hubble “gold” description for card metadata. |
| docs/data/analytics/hubble/data-catalog/data-dictionary/bronze/category.json | Adds Hubble “bronze” description for card metadata. |
| docs/data/analytics/hubble/data-catalog/data-dictionary/README.mdx | Removes duplicated bronze/silver/gold text now stored in metadata. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Codex <noreply@openai.com>
The note PR removed this before this PR somehow, leaving just a little too much ambiguity. This adds something back in to give the reader context on what each page means.
|
Thanks for this one — closing it, with two separate rulings so the related PRs (#2446, #2451) have a clear answer too.
The editorial glossary category improvements underneath are still welcome — if you want to resubmit just those as a swizzle-free, frontmatter-only PR, I'll review it quickly. |

Adds richer DocCard metadata across generated index pages so category cards can carry useful descriptions instead of repeating the same explanatory text inside page bodies.
This PR:
DocCardtheme component that displays descriptions for doc and category cardsWhy
Generated index pages are more useful when the card itself explains where the link goes. This keeps landing pages cleaner while preserving the context users need before clicking through.
For the Hubble data dictionary, this also avoids repeating the same bronze, silver, and gold descriptions above cards that can now carry that metadata directly.