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

Page per method #203

Open
zzak opened this issue Mar 17, 2023 · 3 comments
Open

Page per method #203

zzak opened this issue Mar 17, 2023 · 3 comments
Milestone

Comments

@zzak
Copy link
Member

zzak commented Mar 17, 2023

Methods are currently only accessible from the anchor links on class and module pages.

A common request is to have a specific page for each method, this might also help improve SEO results.

@zzak zzak added this to the 3.0.0 milestone Mar 17, 2023
@chris-hewitt
Copy link

I just stumbled across this thread and noticed the concern about SEO, and that we might still be unsure what the problem is.

Isn't the main problem that the guides are constantly linking to new URLs? For example, on https://guides.rubyonrails.org/routing.html:

Forgive me if this has already been discussed elsewhere!

@p8
Copy link
Member

p8 commented Jan 30, 2024

Hmm, interesting @chris-hewitt
We might want to add a case here when running the current version:
https://github.com/rails/rails/blob/316338acf76c34b529e7d883a916ace798ad8efa/guides/rails_guides/markdown/renderer.rb#L136

Although it could be we move the last version of the guides to a version subdir whenever a new version is released. We prefer to link to the same version of the API docs from the guides.

@chris-hewitt
Copy link

I think that's spot on, @p8.
We could still link [versioned guide] -> [versioned api] as these are essentially archived docs of specific rails versions. But if the current pages are all "clean" urls linking to other "clean" urls, I think that might make a difference. This is covered more here, here, here.

Other things to consider:

  • Having a link to the current "clean" version of an API page, from each of its "versioned" versions, would also probably go a long way. This is another way that sites like APIDock have an advantage. It's also just a useful feature for users. I know this has already been requested and probably already in the works - just reiterating.

  • Canonicalization can be an option but I'm not sure it's something we need to consider. More info

  • Google's URL Inspection Tool (as described here) may also provide some useful insight. It must be run by someone who has access to do the DNS verification.

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

No branches or pull requests

3 participants