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 examples to the website, or make examples more discoverable #4125

Open
jasonwilliams opened this issue Jan 12, 2025 · 1 comment
Open
Labels
E-Easy Easy enhancement New feature or request good first issue Good for newcomers

Comments

@jasonwilliams
Copy link
Member

It would be good to share the examples we have in https://github.com/boa-dev/boa/tree/main/examples onto the website. This would be so people new to Boa could instantly see how it works and how to use it. The discovery of examples at the moment isn't the best although you can eventually find it via the Boa API link.

We could start off with having a top link to "examples" in the nav bar which links to https://docs.rs/boa_engine/latest/boa_engine/

Then maybe some way to show the source code on the website with some output in the console which you can run.

@mdimado
Copy link

mdimado commented Jan 13, 2025

I'd like to contribute to this issue! I'm new to the project, so I have a few questions to help me get started:

  1. Where can I find the code for the website's navigation bar to add a link to "examples"?
  2. Do you have a preferred framework or library for embedding runnable examples and displaying console output?
  3. Are there specific examples from the Boa repository that you'd like to prioritize for this feature?

I'd appreciate any guidance or tips to ensure I align with the project's conventions. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
E-Easy Easy enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants