jherogr / ruby-sinatra-starter-app Goto Github PK

Consider following this popular Ruby Style Guide. Namely, this:

Use two spaces per indentation level (aka soft tabs).

I would recommend to make this into a gem too, so that installation becomes easier.

As for a name, perhaps:

jhero-sinatra-tutorial
jhero_sinatra_tutorial

or something like that.

And then perhaps even self-serve this through sinatra for people to follow; e. g. with sub-routes such as "step1", "step2" etc... to link between them like a chapter in a book.

Not sure how much time you want to invest into this, but I recommend that in the event that you wish to have it available for a longer time, to also consider adding more online documentation for the application / tutorial that you wrote.

For example, I see code such as this erb here:

https://github.com/JHero23/ruby-sinatra-starter-app/tree/master/views

Css here:

https://github.com/JHero23/ruby-sinatra-starter-app/tree/master/public/css

And images here:

https://github.com/JHero23/ruby-sinatra-starter-app/tree/master/public/img

I think online documentation, perhaps either directly in the main README of
this project, or in some link, that would explain how to e. g. use this, would
help with the tutorial part of the project. For example: "what code do I have
to use in order for my sinatra application to show images, when the
images reside in this or that random directory".

Something like this would help IMO.

You don't have to do this in a day :) I think it is more than enough if you keep
that in the back of your mind over the next, say, 18 months or so (so my issue
should also be closed in due time; it's just meant as a recommendation).

Keep up the spirit - documentation in ruby is an area that could definitely be
improved, and the more knowledge people share here the better. Ruby as a
language is great but the documentation is ... hmm, not horrible but not
great; sort of somewhat average/mediocre in general. I learned sinatra some
time ago, I like it a lot, much more than rails; but now I have a hard time finding
more advanced stuff in sinatra. I had to google-collect snippets and stuff,
which is cumbersome, and I still can not solve some issues I'd love to solve
and others have already solved but not explained properly (e. g. authentication
support in a website ... I haven't found a simple solution for this yet).