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

Show badge for legacy documentation search results #533

Merged

Conversation

ben-fornefeld
Copy link
Member

@ben-fornefeld ben-fornefeld commented Jan 10, 2025

This pr adds a badge attribute to documentation indices, which can represent a string literal for certain badge types defined in the Result type.

Possible types at the time of writing: "Legacy" | undefined

On each documentation query, we sort all search results containing a badge value of Legacy at last and render a badge containing the string value in each search result item.

@ben-fornefeld ben-fornefeld added Improvement Improvement for current functionality dashboard Improvements or additions to dashboard labels Jan 10, 2025
@ben-fornefeld ben-fornefeld self-assigned this Jan 10, 2025
Copy link

linear bot commented Jan 10, 2025

Copy link

changeset-bot bot commented Jan 10, 2025

⚠️ No Changeset found

Latest commit: f93d18e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@mlejva
Copy link
Member

mlejva commented Jan 10, 2025

Search looks good. Can you also add a banner/some signal showing the page itself is legacy docs if a user visits it?

@mlejva
Copy link
Member

mlejva commented Jan 10, 2025

Search looks good. Can you also add a banner/some signal showing the page itself is legacy docs if a user visits it?

Per our private convo - let's leave this for a separate PR

Copy link
Member

@mlejva mlejva left a comment

Choose a reason for hiding this comment

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

Ready to go to prod!

@ben-fornefeld ben-fornefeld merged commit fb7f0e3 into main Jan 10, 2025
2 checks passed
@ben-fornefeld ben-fornefeld deleted the badge-for-legacy-docs-when-searching-documentation-e2b-1431 branch January 10, 2025 23:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dashboard Improvements or additions to dashboard Improvement Improvement for current functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants