hanami.github.io
hanami.github.io copied to clipboard
hanami
Docs improvement
I suggest discussing what we want to add to guides. I created a simple list with my ideas. If you have other ideas - let's discuss and update list ❤️
List
Validations
- Copy validation docs from validation repository
- Say that hanami-v based on dry-v
Controllers
- Add information about flash (now we have only information about testing)
- Rendering XML and JSON data in controllers
- Streaming and File Downloads
View
- Improve example with forms (https://github.com/hanami/helpers/blob/0cf7e87eb3ae5abb52f1636af3da6b1855ada19e/lib/hanami/helpers/form_helper.rb#L149-L181)
- Write about DELETE and POST links. In rails, you can find some magic about this. I think we have to describe that developer have to make a form for this.
Router
- Router params. Something like this: http://guides.rubyonrails.org/routing.html#customizing-resourceful-routes
- How to parse JSON
Introduction
- Build simple JSON API project with hanami (something like "Getting Started")
Model
- check this PR: https://github.com/hanami/hanami.github.io/issues/343
Other guides
- How to build custom CLI
- Add information about hanami-utils
- Security Guide
- Debugging hanami app
- Profiling hanami app
- How to contribute to hanami
cc @hanami/core
@davydovanton :+1: I think we have to prioritise guides, most urgents for new users for example.
@AlfonsoUceda extremely agree. In the issue, I want to see all problems in our guides. But we can set priority for each guide too 👍
Do we want to change the Getting Started guide from Minitest to RSpec? I know you've suggested the idea before @davydovanton. Since Hanami itself uses RSpec now, I think it's a good idea. I think most Ruby developers are more familiar with RSpec than Minitest (let alone Minitest's Spec syntax).
@hanami/core What do the rest of you think about switching from Minitest to RSpec throughout the guides?
:+1: for switching from Minitest to Rspec :+1: for prioritizing JSON/JSON API stuff
