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 “Open with CodeSandbox” buttons to example project READMEs #5322

Merged
merged 2 commits into from
Nov 10, 2022

Conversation

Ekwuno
Copy link
Contributor

@Ekwuno Ekwuno commented Nov 8, 2022

Changes

  • What does this change?
    Just like in Edit docs with Codesandbox repos docs#1982. I have been using codesandbox a lot for my open-source contributions, and I think it's really cool. Astro doc contributors can work seamlessly, and I wanted to add it here as an option.

I noticed that in astro.new you have the option to open in codesandbox, but in the repos that are cloned, only the stackBlitz option exists.

  • Be short and concise. Bullet points can help!
  • Before/after screenshots can help as well.
  • Don't forget a changeset! pnpm exec changeset

Testing

Docs

@Ekwuno Ekwuno requested a review from a team as a code owner November 8, 2022 10:17
@changeset-bot
Copy link

changeset-bot bot commented Nov 8, 2022

⚠️ No Changeset found

Latest commit: a41d3c6

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.

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

@github-actions github-actions bot added the pkg: example Related to an example package (scope) label Nov 8, 2022
@Ekwuno Ekwuno changed the title Edit example repos with Codesandbox repos Edit example repos with Codesandbox Nov 8, 2022
@Ekwuno
Copy link
Contributor Author

Ekwuno commented Nov 8, 2022

@sarah11918 just doing some more quality-of-life improvements 😅

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 @Ekwuno!

A lot of suggestions here 😅 But they’re basically all identical: remove a newline so the open buttons appear on the same line.

One README I noticed our existing link was wrong, so suggested fixing that in this PR too.

examples/blog/README.md Outdated Show resolved Hide resolved
examples/component/README.md Outdated Show resolved Hide resolved
examples/deno/README.md Outdated Show resolved Hide resolved
examples/docs/README.md Outdated Show resolved Hide resolved
examples/framework-alpine/README.md Outdated Show resolved Hide resolved
examples/with-mdx/README.md Outdated Show resolved Hide resolved
examples/with-nanostores/README.md Outdated Show resolved Hide resolved
examples/with-tailwindcss/README.md Outdated Show resolved Hide resolved
examples/with-vite-plugin-pwa/README.md Outdated Show resolved Hide resolved
examples/with-vitest/README.md Outdated Show resolved Hide resolved
@delucis delucis changed the title Edit example repos with Codesandbox Add “Open with CodeSandbox” buttons to example project READMEs Nov 10, 2022
Co-authored-by: Chris Swithinbank <[email protected]>
@Ekwuno
Copy link
Contributor Author

Ekwuno commented Nov 10, 2022

Ah! Great catch @delucis I checked the deno example and saw they both open well. I added screenshots as well. Updated with all the suggestions now.

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 for making those changes @Ekwuno — LGTM!

@Ekwuno
Copy link
Contributor Author

Ekwuno commented Nov 10, 2022

Oh! it pointed to basic example. before your suggestion. Just got it.. My bad 😅 @delucis

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg: example Related to an example package (scope)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants