Adding all samples for badges in sidebar as example by mseibert · Pull Request #2881 · withastro/starlight

mseibert · 2025-02-15T21:23:12Z

Description

With this PR all types of badges will be shown directly in the docs which is important to help people chose the right one for their use case.
The current status quo is less verbose. But it puts the work on the reader to try out every badge type to see and test it. That is cumbersome, takes time and unnecessary.
The visual appeal of the badges should be visible directly.

Deeplink: https://deploy-preview-2881--astro-starlight.netlify.app/guides/sidebar/#badge-variants-and-custom-styling

added all variants as a preview.

changeset-bot · 2025-02-15T21:23:16Z

⚠️ No Changeset found

Latest commit: 21ce126

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

astrobot-houston · 2025-02-15T21:23:40Z

Hello! Thank you for opening your first PR to Starlight! ✨

Here’s what will happen next:

Our GitHub bots will run to check your changes.
If they spot any issues you will see some error messages on this PR.
Don’t hesitate to ask any questions if you’re not sure what these mean!
In a few minutes, you’ll be able to see a preview of your changes on Netlify 🤩
One or more of our maintainers will take a look and may ask you to make changes.
We try to be responsive, but don’t worry if this takes a few days.

astrobot-houston · 2025-02-15T21:23:44Z

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

Locale	File	Note
en	guides/sidebar.mdx	Source changed, localizations will be marked as outdated.

Warnings reference

Icon	Description
🔄️	The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

netlify · 2025-02-15T21:23:53Z

✅ Deploy Preview for astro-starlight ready!

Name	Link
🔨 Latest commit	`21ce126`
🔍 Latest deploy log	https://app.netlify.com/sites/astro-starlight/deploys/67b3b8fc78f1e30008e19d28
😎 Deploy Preview	https://deploy-preview-2881--astro-starlight.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 100 (no change from production) Accessibility: 100 (no change from production) Best Practices: 100 (no change from production) SEO: 100 (no change from production) PWA: - View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

trueberryless · 2025-02-16T09:17:42Z

Hello and welcome to the Starlight project!

Thank you for taking the time to create such a detailed Pull Request!

I'm not one of the maintainers, but I generally think that they want to keep the documentation as simple as possible. Looking at the differences between the current documentation and this request, I think that we can agree that your request takes up more space then the current docs:

Current documentation	Your request

In my opinion this is not necessary because if the reader wants to look at all the different Badges, they can just go to the Badges page and under the Usage section, they can see all the Badges available: https://deploy-preview-2881--astro-starlight.netlify.app/components/badges/#usage

So personally, I think that it is not necessary to list all the Badge variantes on the Sidebar Navigation page, because there is already an exclusive page for all the props and things regarding Badges. Moreover, I really think that the documentation should not be too bloated and more subtle and discreet. I really like the section as it is (just my thoughts).

One last thing to notice:

I think if you make a docs change in the Starlight repository, you don't need to include a changeset because the website is deployed by Netlify. As far as I know, you just need to include a changeset if a change somewhere inside the package folder is happening.

mseibert · 2025-02-16T10:20:48Z

In my opinion this is not necessary because if the reader wants to look at all the different Badges, they can just go to the Badges page and under the Usage section, they can see all the Badges available: https://deploy-preview-2881--astro-starlight.netlify.app/components/badges/#usage

Touché, I did not see this other page. Maybe we could agree that a link to this other section could be useful?

See how to use all the different variants, different sizes, and custumizations in the "Usage" section of the Badge component.

That would have helped me not come up with this suggestion here. Or even leaner:

Learn more about using and customizing badges.

What do you think?

trueberryless · 2025-02-16T10:38:31Z

I agree that a link could not hurt anyone, I like both examples, maybe a combination of the things I like from both:

Learn more about using and customizing badges.

(Not the entire sentence is a link + its lean as you said)

Now it's up to the maintainers to decide... ⌛ In the meantime you could adjust the changes, remove the changeset and edit the title and description if you want... Or you wait until one of the maintainers says what would be best... As you like!

mseibert · 2025-02-16T13:58:26Z

In the meantime you could adjust the changes, remove the changeset and edit the title and description if you want...

Will do.

mseibert · 2025-02-16T16:37:17Z

Back to start and added link at right point:

mseibert · 2025-02-16T16:39:02Z

I think if you make a docs change in the Starlight repository, you don't need to include a changeset because the website is deployed by Netlify. As far as I know, you just need to include a changeset if a change somewhere inside the package folder is happening.

Erased changeset.

docs/src/content/docs/guides/sidebar.mdx

Co-authored-by: trueberryless <99918022+trueberryless@users.noreply.github.com>

mseibert · 2025-02-16T20:31:02Z

@trueberryless Good catch. Sorry for missing that.

SnowDingo

Thank you @mseibert for your contribution!

I agree with your latest changes, and I think the addition of the link makes the documentation more concise and also user-friendly.
Because I am not a Starlight maintainer, I can't merge this but I would approve this PR.

Thank you!!
SnowDingo

trueberryless · 2025-02-17T03:54:36Z

@trueberryless Good catch. Sorry for missing that.

No problem, looks good to me now! 🎉

delucis

Thank you for the contribution @mseibert and thanks everyone for reviewing this — I think it ended up in a great spot 🙌

See withastro#2881

See #2881

* main: (493 commits) i18n(de): update `sidebar.mdx` (withastro#2900) Adding all samples for badges in sidebar as example (withastro#2881) i18n(fr): fix highlighting in `reference/plugins.md` (withastro#2898) i18n(fr): update `reference/plugins` & `guides/i18n` (withastro#2886) i18n(fr): update `reference/overrides` & `guides/sidebar` (withastro#2887) i18n(fr): add `guides/route-data` and `reference/route-data` (withastro#2884) i18n(fr): update `guides/overriding-components` (withastro#2885) i18n(fr): update `reference/configuration` (withastro#2888) i18n(de): update German translation with withastro#2578 (withastro#2882) [ci] format i18n(ru): update some translations (withastro#2895) i18n(de): update `reference/configuration.mdx` (withastro#2883) [ci] format i18n(ko-KR): update `configuration.mdx` (withastro#2892) i18n(ko-KR): update `overrides.md` (withastro#2893) i18n(ko-KR): update `overriding-components.mdx` (withastro#2890) i18n(ko-KR): update `i18n.mdx` and `plugins.md` (withastro#2889) [ci] format i18n(ko-KR): create `guides/route-data.mdx` and `reference/route-data.mdx` (withastro#2896) i18n(ko-KR): update `/resources/plugins.mdx` (withastro#2894) ...

mseibert and others added 2 commits February 15, 2025 22:10

Update sidebar.mdx

e06b66f

added all variants as a preview.

formatted with prettier and added to preview

ca8e7fe

github-actions bot added the 📚 docs Documentation website changes label Feb 15, 2025

mseibert changed the title ~~Adding all samples for badges as example~~ Adding all samples for badges in sidebar as example Feb 15, 2025

mseibert added 5 commits February 15, 2025 22:28

added changeset

2893b9a

changed label for caution

49b480f

fixed deployment problem

9452804

added highlights of relevant lines

c02c8b8

fixed label from 'Stub' to 'Caution'

095b5b8

mseibert and others added 4 commits February 16, 2025 15:03

reverted all changes

fc38d3f

added link as discussed in PR

123da55

Merge branch 'main' into patch-1

ca55779

fixed positioning of link

be14c9e

deleted obsolete changeset

12a1158

trueberryless reviewed Feb 16, 2025

View reviewed changes

docs/src/content/docs/guides/sidebar.mdx Outdated Show resolved Hide resolved

Update docs/src/content/docs/guides/sidebar.mdx

f03ffe3

Co-authored-by: trueberryless <99918022+trueberryless@users.noreply.github.com>

SnowDingo approved these changes Feb 17, 2025

View reviewed changes

trueberryless approved these changes Feb 17, 2025

View reviewed changes

Merge branch 'main' into patch-1

21ce126

delucis approved these changes Feb 18, 2025

View reviewed changes

delucis merged commit 8039167 into withastro:main Feb 18, 2025
9 checks passed

trueberryless mentioned this pull request Feb 18, 2025

i18n(de): update sidebar.mdx #2900

Merged

jsparkdev mentioned this pull request Feb 18, 2025

i18n(ko-KR): update sidebar.mdx #2901

Merged

ArmandPhilippot added a commit to ArmandPhilippot/starlight that referenced this pull request Feb 18, 2025

i18n(fr): update sidebar.mdx

248feb1

See withastro#2881

ArmandPhilippot mentioned this pull request Feb 18, 2025

i18n(fr): update sidebar.mdx #2902

Merged

ArmandPhilippot added a commit that referenced this pull request Feb 19, 2025

i18n(fr): update sidebar.mdx (#2902)

070ec8b

See #2881

liruifengv mentioned this pull request Mar 23, 2025

i18n(zh-cn): Update overrides.md and overriding-components.mdx #3006

Merged

morinokami mentioned this pull request Feb 7, 2026

i18n(ja): update frontmatter.md and sidebar.mdx #3699

Merged

Uh oh!

Conversation

mseibert commented Feb 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

changeset-bot bot commented Feb 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

astrobot-houston commented Feb 15, 2025

Uh oh!

astrobot-houston commented Feb 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Lunaria Status Overview

Tracked Files

Uh oh!

netlify bot commented Feb 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for astro-starlight ready!

Uh oh!

trueberryless commented Feb 16, 2025

Uh oh!

mseibert commented Feb 16, 2025

Uh oh!

trueberryless commented Feb 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mseibert commented Feb 16, 2025

Uh oh!

mseibert commented Feb 16, 2025

Uh oh!

mseibert commented Feb 16, 2025

Uh oh!

Uh oh!

mseibert commented Feb 16, 2025

Uh oh!

SnowDingo left a comment

Choose a reason for hiding this comment

Uh oh!

trueberryless commented Feb 17, 2025

Uh oh!

delucis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

mseibert commented Feb 15, 2025 •

edited

Loading

changeset-bot bot commented Feb 15, 2025 •

edited

Loading

astrobot-houston commented Feb 15, 2025 •

edited

Loading

netlify bot commented Feb 15, 2025 •

edited

Loading

trueberryless commented Feb 16, 2025 •

edited

Loading