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

Show code examples on usage site #89

Closed
Tracked by #88
seveibar opened this issue Nov 4, 2024 · 13 comments
Closed
Tracked by #88

Show code examples on usage site #89

seveibar opened this issue Nov 4, 2024 · 13 comments

Comments

@seveibar
Copy link
Contributor

seveibar commented Nov 4, 2024

Currently we build to a usage site here: https://tscircuit.github.io/jscad-fiber

But there is no way to see the code for each example. Let's create a way to see the code for each example. This will help people learn to use jscad-fiber better.

/bounty $40

Copy link

algora-pbc bot commented Nov 4, 2024

💎 $40 bounty • tscircuit

Steps to solve:

  1. Start working: Comment /attempt #89 with your implementation plan
  2. Submit work: Create a pull request including /claim #89 in the PR body to claim the bounty
  3. Receive payment: 100% of the bounty is received 2-5 days post-reward. Make sure you are eligible for payouts

Thank you for contributing to tscircuit/jscad-fiber!

Add a bountyShare on socials

Attempt Started (GMT+0) Solution
🟢 @DevGajjar28 #90
🟢 @anas-sarkez #91

@DhairyaMajmudar
Copy link

DhairyaMajmudar commented Nov 6, 2024

@seveibar How's about adding a code button here in the side menu

Image

and then rendering code snippets below side panel ?

Image

For displaying code snippets we can use https://highlightjs.org

Would like to get your inputs here and assigned the issue to me : )

@seveibar
Copy link
Contributor Author

seveibar commented Nov 6, 2024

Yea thatd be amazing!

Fwiw: I think @anas-sarkez might have picked this one up, he showed me some mockups. Im not sure how far he is.

@AnasSarkiz
Copy link
Member

@DhairyaMajmudar go ahead with that

@DevGajjar28
Copy link

hey @seveibar I had a try and make this Image

@DevGajjar28
Copy link

hey @seveibar I had a try and make this Image

To be honest, I’ve been working on it since yesterday. I haven’t commented yet because I wasn’t sure, but I gave it a try and finally got it done!

@seveibar
Copy link
Contributor Author

seveibar commented Nov 6, 2024

@anas-sarkez can you post your screenshot? It was pretty good- i think it was definitely an acceptable aesthetic

@seveibar
Copy link
Contributor Author

seveibar commented Nov 6, 2024

@DevGajjar28 looks ok but yea syntax highlighting and more of an overlay or integrated into cosmos is better.

As far as who gets it im just going to merge PRs and do reviews like i normally would, for frequent contributors i do assignments but this repo doesnt have many freqent contributors

@AnasSarkiz
Copy link
Member

Image

@DevGajjar28
Copy link

Hey @seveibar, I have completed the task and am raising my PR. Please review it!
Preview:
https://github.com/user-attachments/assets/882150b1-15ef-498f-aaee-0d76af81c935

Copy link

algora-pbc bot commented Nov 6, 2024

💡 @DevGajjar28 submitted a pull request that claims the bounty. You can visit your bounty board to reward.

Copy link

algora-pbc bot commented Nov 8, 2024

💡 @anas-sarkez submitted a pull request that claims the bounty. You can visit your bounty board to reward.

Copy link

algora-pbc bot commented Nov 23, 2024

🎉🎈 @anas-sarkez has been awarded $40! 🎈🎊

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

No branches or pull requests

4 participants