Add Guides 2.0 #90
Add Guides 2.0 #90
Conversation
| # /config/routes.rb | ||
|
|
||
| Hanami.application.routes do | ||
| slice :main, at: "/" do |
There was a problem hiding this comment.
Should we explain how slice routing works here too, at least briefly? There will be more guides about slices, of course, but this will be a new concept to almost everyone so briefly mentioning it's something new to learn could be useful (though the routing portion here is almost trivial and obvious).
There was a problem hiding this comment.
This is also a topic I briefly mentioned in the basic_usage - Let's discuss if it's better to put it here when I'll push remaining docs :). I've not a strong opinion about it yet.
Add note about Hanami v1.3 requiring Ruby 2
|
|
||
| ## Mounting an application | ||
|
|
||
| In Hanami, you can mount any rack application in desired route. If we want to do it, you should use the `mount` keyword. |
There was a problem hiding this comment.
This is in the rack configuration, right? config.ru rather than a route files?
There was a problem hiding this comment.
oh, is it? I will check, thanks! I know it was in the config in 1.3, but I think I saw it changed in new tests.
Will get back to it! cc: @jodosha
There was a problem hiding this comment.
Nope, it's the router.
@swilgosz I strongly advice to wrap those lines into the following block:
# config/routes.rb
module MyApp
class ApplicationRoutes < Hanami::Application::Routes
mount # ...
end
endPlease be aware that this syntax may change, but at least it's crystal clear of what we're talking about: application routes, and not config.ru.
I would not use "keyword" but "method" instead. Usually keywords are langs constructs.
There was a problem hiding this comment.
@jodosha ATM Hanami2APplication template does not inherit from Hanami::Application::Routes, but rather passes a block to the main class
https://github.com/hanami/hanami-2-application-template/blob/main/config/routes.rb
|
|
||
| It generates: | ||
|
|
||
| <table class="table table-bordered table-striped"> |
There was a problem hiding this comment.
Can we change this to (GitHub-flavored) Markdown tables? https://github.github.com/gfm/#tables-extension-
There was a problem hiding this comment.
Sure. I copied it from existing docs, but if other syntax works better, I don't mind.
Co-authored-by: Sean Collins <cllns@users.noreply.github.com>
Co-authored-by: Sean Collins <cllns@users.noreply.github.com>
Reason: We do not recommend handling requests this way, but it is worth mentioning How it works and that it is possible.
Co-authored-by: Sean Collins <cllns@users.noreply.github.com>
Co-authored-by: Sean Collins <cllns@users.noreply.github.com>
Co-authored-by: Sean Collins <cllns@users.noreply.github.com>
Co-authored-by: Sean Collins <cllns@users.noreply.github.com>
Co-authored-by: Sean Collins <cllns@users.noreply.github.com>
Co-authored-by: Sean Collins <cllns@users.noreply.github.com>
Co-authored-by: Sean Collins <cllns@users.noreply.github.com>
Co-authored-by: Sean Collins <cllns@users.noreply.github.com>
| lib | ||
| ├── bookshelf | ||
| │ ├── action.rb | ||
| │ ├── entities |
There was a problem hiding this comment.
@swilgosz No biggie, but maybe a tailing slash for directories would improve the readability, e.g.
├── entities/
├── entities.rb
├── foodir/
└── barfile
There was a problem hiding this comment.
good idea! BTW: not sure, if you are aware, but you can suggest changes inside reviews, that I can accept directly as your commit
Overview
Guides for Hanami 2.0