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

chore: Add permalinks to the cairo-by-example project #100

Open
mazurroman opened this issue Mar 18, 2024 · 6 comments
Open

chore: Add permalinks to the cairo-by-example project #100

mazurroman opened this issue Mar 18, 2024 · 6 comments
Assignees
Labels
documentation Improvements or additions to documentation OD hack

Comments

@mazurroman
Copy link
Contributor

The cairo-by-examples project contains many Cairo code snippets. It would be great to add a link below relevant code snippets to open them in the Cairo playground on cairovm.codes so that devs can play with the code execution to understand it better.

cairovm.codes has a permalink feature, so that you can write some Cairo code and share it.

For the following code snippets, you should:

  1. copy the code snippet into the Cairo playground of cairovm.codes,
  2. generate a permalink,
  3. add a “Open in Cairo playground” link pointing to the permalink, below the code snippet.

Acceptance criteria:
Create PRs on the cairo-by-example project with permalinks to cairovm.codes for the following code snippets:

PR Review

The PRs on the cairo-by-examples project should be reviewed in 2 steps:

  • The Walnut core team will review the PR, give feedback and may decide to give some rewards on OnlyDust if the PR code is good quality.
  • The cairo-by-examples team will review the PR as they see fit and decide whether to merge the PR or not.
@mazurroman mazurroman converted this from a draft issue Mar 18, 2024
@mazurroman mazurroman moved this from Triage to Todo in cairovm.codes Mar 18, 2024
@mazurroman mazurroman added documentation Improvements or additions to documentation OD hack labels Mar 18, 2024
@mazurroman mazurroman changed the title chore: Add permalinks to cairo book and cairo-by-example (https://cairo-by-example.com/examples/loop/) chore: Add permalinks to the cairo-by-example project Mar 18, 2024
@Joy-Adah
Copy link

Can I be assigned to this?

@Ayoazeez26
Copy link

@mazurroman I'd like to pick this up.

@wugalde19
Copy link

Hi, I'd love to take care of this

@Calebux
Copy link

Calebux commented Mar 19, 2024

I have gone through this and i'll be able to handle this appropriately

@jaipaljadeja
Copy link
Contributor

Hi I am Jaipal (intro), i can take this issue. although i did check that cairovm.codes perma links contains some conflicting characters such as parenthisis which might mess with the markdown sytanx. i can encode them which should most definitely work if not might just shorten the links using dub.co (a good opensource link shortner) as the last resort if needed.

@jaipaljadeja
Copy link
Contributor

Just raised a PR #116 for this.

@mazurroman mazurroman moved this from Todo to Review in cairovm.codes Mar 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation OD hack
Projects
Status: Review
Development

No branches or pull requests

6 participants