docs: add showcase section to the contributing guide#1606
docs: add showcase section to the contributing guide#1606HiDeoo merged 3 commits intowithastro:mainfrom
Conversation
|
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
at-the-vr
left a comment
There was a problem hiding this comment.
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.
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.
honestly this insight can be overlooked because how trivial it might be in this early stages of Starlight
sarah11918
left a comment
There was a problem hiding this comment.
Helped edit on Talking and Doc'ing!
|
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.mdxso that it's easier to find.