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

Have the right anchors in documentation to help search engines #1922

Open
ViralBShah opened this issue Sep 6, 2022 · 3 comments
Open

Have the right anchors in documentation to help search engines #1922

ViralBShah opened this issue Sep 6, 2022 · 3 comments
Labels
Format: HTML Related to the default HTML output Type: Enhancement

Comments

@ViralBShah
Copy link
Contributor

ViralBShah commented Sep 6, 2022

For example, when you google "julia kron doc", it sends you to the LinearAlgebra documentation at https://docs.julialang.org/en/v1/stdlib/LinearAlgebra/. If possible, we should have the right anchors on the page so that search engines can send you directly to the relevant section on that page.

Or alternatively, it would be nice to have one page per function (although many would then look a bit empty, since they are often terse).

cc @Keno @StefanKarpinski

@mortenpi mortenpi added Type: Enhancement Format: HTML Related to the default HTML output labels Sep 7, 2022
@mortenpi
Copy link
Member

mortenpi commented Sep 7, 2022

Hmm. We put the name of each of the docstrings in a <header> tag (inside the <article> container of each docstrings), whereas maybe we should use <h1> instead (based on looking at mdn for <article> and <header>).

@MarkNahabedian
Copy link
Contributor

MarkNahabedian commented Nov 29, 2022

Would leaving a name anchor, e.g. <a name="fragment"/> help here?

@mortenpi
Copy link
Member

mortenpi commented Nov 29, 2022

Looking at the docs, the name attribute looks to be the same as id and seems to be pretty much deprecated. And we already have anchors with ids:

image

I still think that using a proper heading, instead of the <header> tag, should promote this for the search engines.

@mortenpi mortenpi added this to the 0.28.0 milestone Nov 29, 2022
@mortenpi mortenpi modified the milestones: 1.0.0, 1.1.0 Jul 18, 2023
@mortenpi mortenpi removed this from the 1.1.0 milestone Sep 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Format: HTML Related to the default HTML output Type: Enhancement
Projects
None yet
Development

No branches or pull requests

3 participants