Svelte: Site: Renaming API Docs path from "/docs" to "/api"

Created on 21 Nov 2020  路  2Comments  路  Source: sveltejs/svelte

Is your feature request related to a problem? Please describe.
The path for the API Docs is currently /docs which can be surprising given the other pages:

  • Tutorial = tutorial
  • API = docs
  • Examples = examples
  • REPL = repl
  • Blog = blog
  • FAQ = faq

Describe the solution you'd like
I'd propose renaming the path to "/api" and adding a redirect (301 permanent) from the current "svelte.dev/docs".

Describe alternatives you've considered
The least source of friction would be to do the reverse, by keeping it as "/docs" and adding a new redirect from "svelte.dev/api". I'd suggest doing that as a minimum. People can of course also just go to "svelte.dev" and then click the nav link, or simply Ask Jeeves for "svelte api" and click the first result.

How important is this feature to you?
Seeing a 404 evidently doesn't tear the ground asunder; it's just a mild inconvenience when you visit "svelte.dev/api" but I believe this is a logical change.

Additional context
I'll do the PR if thoughts agree.

Most helpful comment

Thanks for pointing this out. I think we'd rather do the reverse and rename the text to be "Docs" or "Documentation"

All 2 comments

Thanks for pointing this out. I think we'd rather do the reverse and rename the text to be "Docs" or "Documentation"

Agreed. That is content-facing so I was wary of suggesting too visible a change, but I think that is the best approach mentioned too. I'll put the PR in soon!

Was this page helpful?
0 / 5 - 0 ratings