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

Update README.md #230

Closed
wants to merge 1 commit into from
Closed

Update README.md #230

wants to merge 1 commit into from

Conversation

gobijan
Copy link

@gobijan gobijan commented Jan 21, 2025

Add reference to the Rubydoc API documentation to make it easier to navigate.

Add reference to the Rubydoc API documentation to make it easier to navigate.
@brenogazzola
Copy link
Collaborator

brenogazzola commented Feb 4, 2025

Thank you for your contribution, but none of the rails gems (old or new) include such a reference in the README file, so I'll follow their lead and say it's not needed here either.

@gobijan
Copy link
Author

gobijan commented Feb 5, 2025

Maybe this should be changed throughout the rails gems too?
From a users perspective it’s clearly better to have a direct reference to the API documentation. This is quite a normal thing in other ecosystems such as Go etc.
I just found myself repeatedly jumping back and forth and it was annoying. I also don’t want to be contributor or whatever. It’s just the right thing to do in order to reduce friction. What would be the right channel to discuss?

@brenogazzola
Copy link
Collaborator

brenogazzola commented Feb 5, 2025

Two ways I’ve used in the past:

  1. Open a PR on rails, post to the official forum (more visibility) with a link to the PR
  2. Join the discord channel and ask about it on the contribution channel.

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

Successfully merging this pull request may close these issues.

2 participants