platformio / platformio-docs

PlatformIO Documentation
https://docs.platformio.org
Apache License 2.0
243 stars 326 forks source link

What kind of links should I use? "/page/" or "/en/latest/"? #275

Closed MacDada closed 1 year ago

MacDada commented 1 year ago

In my platformio.ini I see the link https://docs.platformio.org/page/projectconf.html -> it redirects to https://docs.platformio.org/en/latest/projectconf/index.html

I like to heavily document my code/config files, so I want to include links to the official docs.

Which kind of links should I use?

I guess that /page/ might be more universal, but I don't know the reasons behind the redirects.

ivankravets commented 1 year ago

The page-type URL is a legacy format from the previous place where docs where hosted. Nevertheless, you can use any of them. I recommend using /en/latest/.