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

Put code examples more front-and-center in the README #424

Open
masak opened this issue Mar 26, 2022 · 0 comments
Open

Put code examples more front-and-center in the README #424

masak opened this issue Mar 26, 2022 · 0 comments

Comments

@masak
Copy link
Owner

masak commented Mar 26, 2022

This HN comment made me think.

This seems neat. I love that there are examples front-and-center on the README page. This is exactly what I want and the first thing I would think to put when demonstrating a new language, but sadly this is rare.

We already have code examples of Bel code in the README.md, but they are "below the fold", after

  • Title
  • A "CI passing" badge
  • An informal high-level description
  • Getting-started instructions

Suggesting we put the examples directly after the title.

I'm also wondering if there is something we can do to make the examples more impressive, but that's more of a back-burner idea, not something actionable for this issue.

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

No branches or pull requests

1 participant