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

docs: add showcase section to the contributing guide #1606

Merged
merged 3 commits into from
Mar 28, 2024

Conversation

HiDeoo
Copy link
Member

@HiDeoo HiDeoo commented Mar 6, 2024

What kind of changes does this PR include?

  • Changes or translations of Starlight docs site content
  • Something else!

Description

This PR adds a new section to the contributing guide, which explains how to add a showcase entry to the Starlight docs site which is something that was never properly documented before.

I've also added a link to this new section in docs/src/content/docs/resources/showcase.mdx so that it's easier to find.

Copy link

changeset-bot bot commented Mar 6, 2024

⚠️ No Changeset found

Latest commit: 92a31a8

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

Copy link

vercel bot commented Mar 6, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
starlight ✅ Ready (Inspect) Visit Preview Mar 28, 2024 0:34am

Copy link
Member

@at-the-vr at-the-vr left a comment

Choose a reason for hiding this comment

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

Great PR, solves a lotta nits with showcase PRs. I thought of a "simple edge-case" regardless its LGTM 👍

CONTRIBUTING.md Outdated
- The `thumbnail` attribute should be the filename of the screenshot you added in step 2.

```diff
<Card title="Astro Docs" href="https://docs.astro.build" thumbnail="docs.astro.build.png" />
Copy link
Member

Choose a reason for hiding this comment

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

I can imagine someone new to showcase-sites trying to find Astro Docs so that they can place their site underneath it 😅 despite 3.1 instruction clearly stating it should be appended at the end

Copy link
Member

Choose a reason for hiding this comment

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

honestly this insight can be overlooked because how trivial it might be in this early stages of Starlight

Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

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

Helped edit on Talking and Doc'ing!

Copy link
Contributor

@casungo casungo left a comment

Choose a reason for hiding this comment

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

LGTM!

@HiDeoo
Copy link
Member Author

HiDeoo commented Mar 28, 2024

Thanks everyone for your help 🙌

@HiDeoo HiDeoo merged commit 2b7d906 into withastro:main Mar 28, 2024
9 checks passed
@HiDeoo HiDeoo deleted the hd-contributing-showcase branch March 28, 2024 12:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 docs Documentation website changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants