Skip to content
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

Expand on API docs for form helper #239

Open
jodosha opened this issue Oct 4, 2023 · 2 comments
Open

Expand on API docs for form helper #239

jodosha opened this issue Oct 4, 2023 · 2 comments
Assignees

Comments

@jodosha
Copy link
Member

jodosha commented Oct 4, 2023

Fuller explanations, more examples, etc. Just look at how much is in Rails' docs for this area.

@jodosha jodosha converted this from a draft issue Oct 4, 2023
@timriley timriley self-assigned this Oct 4, 2023
@timriley timriley moved this from Todo to In Progress in Hanami 2.1 Oct 16, 2023
@timriley timriley moved this from In Progress to Todo in Hanami 2.1 Oct 18, 2023
@jodosha jodosha moved this from Todo to Maybe in Hanami 2.1 Oct 19, 2023
@jodosha jodosha assigned jodosha and unassigned timriley Oct 19, 2023
@olivierlacan
Copy link

Are there Form docs for 2.x? I can't find them in the Guides or in https://docs.hanamirb.org/ which seems to only include 1.3.3 and earlier.

Is it just a matter of porting over what's in https://guides.hanamirb.org/v1.3/helpers/forms/ or is there more that needs to be done?

I noticed while trying out 2.1 that while form_for accepts sympols, the individual tag helpers don't, which was a bit shocking and didn't seem obvious until I looked at the inline documentation in FormBuilder itself. The only place I saw with extracted inline docs was https://gemdocs.org/gems/hanami/2.1.0.rc1/ which is linked to from the GitHub README but seemingly nowhere on hanamirb.org at least in Google's index: https://www.google.com/search?q=site%3Ahanamirb.org+gemdocs.org.

@timriley
Copy link
Member

timriley commented Nov 6, 2023

Hey @olivierlacan! Looks like you found the API docs (which come from https://github.com/hanami/hanami/blob/main/lib/hanami/helpers/form_helper.rb and https://github.com/hanami/hanami/blob/main/lib/hanami/helpers/form_helper/form_builder.rb).

We're currently porting these into the new 2.1 guides. Work is underway in hanami/guides#219 and hanami/guides#221 so far.

In fact, the 2.1 guides are ~85% done and we plan to finish them in the next two weeks. You can see what's there by browsing the content/v2.1/ directory in the guides-2.1 branch. I'm hoping we can merge this branch and hit publish ASAP, since what's already there will be useful to testers.

As for API docs, we definitely need to make sure we're linking to and exposing the API docs in a place users can find. For now though we're focused on getting the guides shipped first. The API docs story will hopefully be something that quickly follows.

I hope this all helps! Please let us know if you have any other questions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Maybe
Development

No branches or pull requests

3 participants