Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move glossary definitions to yaml format #6162

Merged
merged 1 commit into from
Oct 22, 2024
Merged

Move glossary definitions to yaml format #6162

merged 1 commit into from
Oct 22, 2024

Conversation

parlough
Copy link
Member

@parlough parlough commented Oct 22, 2024

Converts the site-wide glossary to be hosted in a YAML file. Initially, only a few of the fields are used:

  • term - for the header entry and default fragment
  • id - (optional) to override the default fragment
  • long_description - (but will fallback to short_description if missing)
  • related_links - For linking to other docs

A few other fields have been added for experimentation but are not yet used or surfaced.

  • short_description - A shorter description to be shown on hover
  • category - A primary category for the term
  • labels - Labels/topics that can be used for filtration
  • alternate - Alternate and related terms that should lead to this entry. Could be because they are synonyms or that term doesn't yet have a specific entry of its own, but is still relevant enough.

Also new to the page:

  • A horizontal line between entries to help visually separate them.
  • A related links section after the long description.

The current style of this information will likely be completely replaced as more information is surfaced and filtering is added.


This work is roughly based on the design proposed in https://flutter.dev/go/glossary-expansion and the Fuchsia glossary.

Resolves #6143


Staged: https://dart-dev--pr6162-feat-6143-bema0uix.web.app/resources/glossary

@dart-github-bot
Copy link
Collaborator

Visit the preview URL for this PR (updated for commit 7830294):

https://dart-dev--pr6162-feat-6143-bema0uix.web.app

Copy link
Collaborator

@sfshaza2 sfshaza2 left a comment

Choose a reason for hiding this comment

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

lgtm

Copy link
Contributor

@MaryaBelanger MaryaBelanger left a comment

Choose a reason for hiding this comment

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

Looking forward to this coming together!

@parlough parlough merged commit 6aab579 into main Oct 22, 2024
10 checks passed
@parlough parlough deleted the feat/6143 branch October 22, 2024 20:42
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.

Move glossary to YAML-based format with categorization fields
4 participants