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

[SEO] Remove .html from generated in breadcrumbs and DocFX API navigation tree #254

Open
pepinho24 opened this issue Oct 18, 2022 · 2 comments
Labels
bug Something isn't working est: medium Estimated for 3-5 dev days high priority The task is with highest priority sev: medium Impacts more than 3 documentations sites

Comments

@pepinho24
Copy link
Collaborator

Describe the bug
Links generated in breadcrumbs and DocFX API navigation tree end with .html

To Reproduce
Example: https://docs.telerik.com/blazor-ui/components/map/overview
The light green are redirects: in the breadcrumb

image

Example: https://docs.telerik.com/devtools/wpf/api/telerik.windows.controls.raddocking - in the side tree and also internal

image

Expected behavior
For SEO optimizations, the generated URLs should not end with .html

Additional context

@pepinho24 pepinho24 added bug Something isn't working high priority The task is with highest priority sev: medium Impacts more than 3 documentations sites est: medium Estimated for 3-5 dev days labels Oct 18, 2022
@pepinho24
Copy link
Collaborator Author

pepinho24 commented Oct 18, 2022

  1. The breadcrumb issue could be fixed in the following line, where the url property should have the .html stripped:
    https://github.com/telerik/docs-seed/blob/master/_plugins/navigation.rb#L214
    "<a href='#{baseurl}#{url.gsub(".html", "")}'>#{format_title(title)}</a>#{so_far}"

  2. The API pages are generated by DocFX where we have little to no control. Ultimately, we might need to create a solution similar to the one stripping out the .html extension in the sitemap, discussed in API ref generated by DocFX adds .html extension to links in sitemap.xml #250

@jivanova
Copy link
Contributor

@nikolay-nenkov @Mike4o

Could you please plan this with priority as it is related to the SEO of the docs site?

// side effect from #250

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working est: medium Estimated for 3-5 dev days high priority The task is with highest priority sev: medium Impacts more than 3 documentations sites
Projects
None yet
Development

No branches or pull requests

2 participants