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

hint on deprecated docs / SEO #30

Open
Laubeee opened this issue Aug 29, 2022 · 2 comments
Open

hint on deprecated docs / SEO #30

Laubeee opened this issue Aug 29, 2022 · 2 comments

Comments

@Laubeee
Copy link

Laubeee commented Aug 29, 2022

(copy of Project-OSRM/osrm-backend#6328)
For some reason, googling "osrm table api docs" first results leads me to v5.5.1

a hint and/or an easy way to switch api versions would be much appreciated (took me quite some time until I realized I was looking at an old doc). For inspiration, visit an old sunpy docs page

@jcoupey
Copy link

jcoupey commented Aug 29, 2022

It looks like docs for most recent versions are not properly published over there. My guess is that those pages used to be automatically generated from https://github.com/Project-OSRM/osrm-backend/blob/master/docs/http.md. Maybe we should remove all content under http://project-osrm.org/docs/ so that the http.md file becomes the sole (versioned) reference?

@mjjbell
Copy link
Member

mjjbell commented Aug 30, 2022

Yes the publishing is a manual process. I did the last one a while back.

It's generated from a combination of http.md and libosrm.md and doesn't appear to have anything smart like SEO support or understanding of versions.

Probably the simplest thing to do is create a new top-level 'user-docs' markdown file as an entry point, and change the link from project-osrm.org to refer to that instead. The downside being it might be a bit harder to find the relevant docs for a specific older version.

We can do this as part of the docs tidying for the next release.

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