-
-
Notifications
You must be signed in to change notification settings - Fork 592
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
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this 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" /> |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
There was a problem hiding this 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!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Thanks everyone for your help 🙌 |
What kind of changes does this PR include?
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.