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

[Feature]: Support codesandbox to provide interactive examples #7

Open
1 of 2 tasks
manudeli opened this issue Jan 19, 2023 · 12 comments · May be fixed by #867
Open
1 of 2 tasks

[Feature]: Support codesandbox to provide interactive examples #7

manudeli opened this issue Jan 19, 2023 · 12 comments · May be fixed by #867
Assignees

Comments

@manudeli
Copy link
Member

Package Scope

docs

  • Add to an existing package
  • New package

Package name:

Overview

Describe the solution you'd like

Additional context

@manudeli
Copy link
Member Author

@minsoo-web How about making Pull Request for adding codesandbox embed in documentation
Let's make our documentation like Panda CSS. Can I assign you with me?

@minsoo-web
Copy link
Member

Of course. It is my pleasure. I will do my best 🚀🚀🚀

@minsoo-web
Copy link
Member

image

How about like this case ?
https://polaris.shopify.com/components/typography/text

manudeli added a commit that referenced this issue Oct 29, 2023
related with #7 

# Overview

<!--
    A clear and concise description of what this pr is about.
 -->

I initialize codesandbox ci followiing its guide
<img width="1722" alt="image"
src="https://github.com/suspensive/react/assets/61593290/fc01ffa9-88af-43ed-8777-3eb5fe7b6fc3">

## PR Checklist

- [x] I did below actions if need

1. I read the [Contributing
Guide](https://github.com/suspensive/react/blob/main/CONTRIBUTING.md)
2. I added documents and tests.
@manudeli
Copy link
Member Author

manudeli commented Nov 2, 2023

@manudeli
Copy link
Member Author

@minsoo-web Could I assign you for v2 docs soon?

@sonsurim We need someone have no experience for this library to see how difficulty to onboard with this. Could you be the one to see it objectively?

@minsoo-web
Copy link
Member

@minsoo-web Could I assign you for v2 docs soon?

Of course, I'll work on it

@sonsurim
Copy link
Contributor

@sonsurim We need someone have no experience for this library to see how difficulty to onboard with this. Could you be the one to see it objectively?

@manudeli
Sure, that's great, I'll see it out and leave a comment!

@sonsurim
Copy link
Contributor

sonsurim commented Jan 19, 2024

@manudeli I was just wondering, Could I see it when it's done?

@manudeli
Copy link
Member Author

manudeli commented Jan 19, 2024

@manudeli I was just wondering, Could I see it when it's done?

@sonsurim I guess that v2 will be release until at least in March, After then We need to do this work(codesandbox for interactive examples) in v2. at that time We need your help for new examples or comment or review

@manudeli
Copy link
Member Author

manudeli commented Jan 19, 2024

reference

https://github.com/TanStack/query/blob/main/.codesandbox/ci.json

We can check examples in Pull Request too.
image

@minsoo-web
Copy link
Member

@manudeli

I'd like to ask for your opinion, the docs of @chara-ui/react, which I'm using as a reference, are provided as a library called react-live. I'm impressed that you can add scope, so that you can modify only the code blocks you need without separate function declarations and import syntax.

However, I think the import syntax is necessary information for the user, and the function declaration and use-case should also show the entire code. I'd love to hear your thoughts on whether using react-live or sandpack is the right way to go!

@minsoo-web minsoo-web linked a pull request Apr 28, 2024 that will close this issue
1 task
@manudeli
Copy link
Member Author

@minsoo-web This issue is important. share plan please if you can

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants