Add Guides 2.0

[swilgosz]

Overview

Guides for Hanami 2.0

• Getting Started
• Architecture
  • Overview
• Router
  • Overview
  • Basic Usage
  • Advanced Usage
  • Testing
• Actions
• Views
• Persistance
• Validations
• Slices
• Assets
• Utils
• Helpers
• Mailers
• Command Line
• Upgrade Notes

[cllns]

🎉 Excited we're getting started with these 2.0 guides. Great work :)

[cllns]

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).

[swilgosz]

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.

[cllns]

This is in the rack configuration, right? config.ru rather than a route files?

[swilgosz]

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

[jodosha]

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
end

Please 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.

[swilgosz]

@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

[cllns]

Can we change this to (GitHub-flavored) Markdown tables? https://github.github.com/gfm/#tables-extension-

[swilgosz]

Sure. I copied it from existing docs, but if other syntax works better, I don't mind.

[svoop]

@swilgosz No biggie, but maybe a tailing slash for directories would improve the readability, e.g.

├── entities/
├── entities.rb
├── foodir/
    └── barfile

[swilgosz]

good idea! BTW: not sure, if you are aware, but you can suggest changes inside reviews, that I can accept directly as your commit

[svoop]

@swilgosz IC, will do next time.

[swilgosz]

Closed in favour of #97 #98 #99 and other per-chapter prs