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

add new example to showcase #1070

Merged
merged 4 commits into from
Nov 17, 2023
Merged

add new example to showcase #1070

merged 4 commits into from
Nov 17, 2023

Conversation

o-az
Copy link
Contributor

@o-az o-az commented Nov 15, 2023

https://docs.ethfollow.xyz/

What kind of changes does this PR include?

  • Minor content fixes (broken links, typos, etc.)
  • Changes or translations of Starlight docs site content
  • Changes to Starlight code
  • Something else!

Description

  • Closes #
  • What does this PR change? Give us a brief description.
  • Did you change something visual? A before/after screenshot can be helpful.

Copy link

changeset-bot bot commented Nov 15, 2023

⚠️ No Changeset found

Latest commit: 1080498

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 Nov 15, 2023

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

Name Status Preview Updated (UTC)
starlight ✅ Ready (Inspect) Visit Preview Nov 17, 2023 11:12am

@github-actions github-actions bot added the 📚 docs Documentation website changes label Nov 15, 2023
Copy link
Collaborator

@astrobot-houston astrobot-houston left a comment

Choose a reason for hiding this comment

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

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

Here’s what will happen next:

  1. 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!

  2. In a few minutes, you’ll be able to see a preview of your changes on Netlify 🤩

  3. 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.

@HiDeoo
Copy link
Member

HiDeoo commented Nov 15, 2023

Thanks for your contribution 🙌

It looks like you wanted to add docs.ethfollow.xyz to the showcase but you actually added it to the list of community plugins.

Here are the steps to add a site to the showcase:

  1. Remove your current changes
  2. Edit docs/src/components/showcase-sites.astro to add your website at the end of the existing list, e.g.:
  <Card
    title="React Awesome Reveal"
    href="https://react-awesome-reveal.morello.dev/"
    thumbnail="react-awesome-reveal.morello.dev.png"
  />
+ <Card
+   title="Ethereum Follow Protocol"
+   href="https://docs.ethfollow.xyz/"
+   thumbnail="docs.ethfollow.xyz.png"
+ />
</FluidGrid>
  1. Add a preview image to the docs/src/assets/showcase/ directory named docs.ethfollow.xyz.png (the image should be 800px × 450px - you can look at existing images for reference)

If needed, a PR adding a website to the showcase that can be used as a template is this one.

If you have any questions, feel free to ask.

@o-az
Copy link
Contributor Author

o-az commented Nov 16, 2023

Thanks for your contribution 🙌

It looks like you wanted to add docs.ethfollow.xyz to the showcase but you actually added it to the list of community plugins.

Here are the steps to add a site to the showcase:

  1. Remove your current changes
  2. Edit docs/src/components/showcase-sites.astro to add your website at the end of the existing list, e.g.:
  <Card
    title="React Awesome Reveal"
    href="https://react-awesome-reveal.morello.dev/"
    thumbnail="react-awesome-reveal.morello.dev.png"
  />
+ <Card
+   title="Ethereum Follow Protocol"
+   href="https://docs.ethfollow.xyz/"
+   thumbnail="docs.ethfollow.xyz.png"
+ />
</FluidGrid>
  1. Add a preview image to the docs/src/assets/showcase/ directory named docs.ethfollow.xyz.png (the image should be 800px × 450px - you can look at existing images for reference)

If needed, a PR adding a website to the showcase that can be used as a template is this one.

If you have any questions, feel free to ask.

Thank you!

Copy link
Member

@delucis delucis left a comment

Choose a reason for hiding this comment

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

Thanks @o-az! The build was failing because you hadn’t actually added the docs.ethfollow.xyz.png image the <Card> component was looking for. I’ve add that screenshot now, so this is good to go!

@delucis delucis merged commit 1ec69e9 into withastro:main Nov 17, 2023
6 checks passed
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.

4 participants