Skip to content

⚓ Refresh glossary categories and doc card formatting#2411

Open
JFWooten4 wants to merge 10 commits intostellar:mainfrom
JFWooten4:723-pt-9
Open

⚓ Refresh glossary categories and doc card formatting#2411
JFWooten4 wants to merge 10 commits intostellar:mainfrom
JFWooten4:723-pt-9

Conversation

@JFWooten4
Copy link
Copy Markdown
Contributor

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:

  • Adds a custom DocCard theme component that displays descriptions for doc and category cards
  • Moves the Hubble bronze, silver, and gold explanations into category metadata
  • Removes the duplicate inline Hubble category descriptions from the data dictionary index
  • Adds descriptions for several Fundamentals categories:
    • Stellar Data Structures
    • Operations & Transactions
    • Smart Contracts
    • Data Format

Why

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.

Copilot AI review requested due to automatic review settings April 28, 2026 20:39
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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/DocCard implementation + 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.

Comment thread src/theme/DocCard/index.tsx
Comment thread src/theme/DocCard/index.tsx
Comment thread src/theme/DocCard/index.tsx Outdated
Comment thread src/theme/DocCard/styles.module.scss Outdated
@JFWooten4
Copy link
Copy Markdown
Contributor Author

comparison

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants