Skip to content

[Documentation] One tutorial to rule them all #94

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

Open
rubyFeedback opened this issue Apr 18, 2025 · 2 comments
Open

[Documentation] One tutorial to rule them all #94

rubyFeedback opened this issue Apr 18, 2025 · 2 comments

Comments

@rubyFeedback
Copy link

I recently found herb. I last used erb years ago so my memory is kind of hazy.

It would be nice if herb could offer one tutorial or a tutorial style. Something
like an extended "hello world". Right now it shows how to install it, and the
API, but I am missing a bit (or have not found) a tutorial in between. This does
not have to be overly long (though I would not mind either), just to showcase
a few things, give people a few ideas how to try it out; and perhaps also give
one or two more examples how to integrate it into a small sinatra-application
or rails example. Ideally none of this should be too long, but it should have
enough information to get people going and then learn more on their own.

@bibstha
Copy link

bibstha commented Apr 24, 2025

+1 to this. Ideally if there is a way to start reaping the benefits from let's say a VSCode editor, that would be amazing.

@marcoroth
Copy link
Owner

Hey @rubyFeedback, thanks for opening this issue!

I agree that the documentation is a bit sparse right now, but this is also kind of on purpose. This initial public release was meant as a "tooling developer preview" so tooling developers can start looking into it and start building on top of it.

Right now there is no way to use Herb to render (HTML+)ERB files which might address the point you are making with how to be able to use it from Sinatra. Currently you cannot.

As @bibstha points out, next up are definitely editor/LSP integrations, so you get to benefit from the what parser sees on every keystroke in your editor. The first thing where I'm going to integrate Herb is Stimulus LSP to finally ship the full ERB support.

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

3 participants