platformio-docs icon indicating copy to clipboard operation
platformio-docs copied to clipboard

Bad "next" link in platformIO documentation

Open Navis-Raven opened this issue 7 years ago • 4 comments

Hi, Go to this webpage : https://docs.platformio.org/en/latest/userguide/account/cmd_token.html

Note that we are on "platformio account token" section Then click on Next: image

And after clicking on next you return back to the previous "platformio boards" section image

So the "next" link is not correct

As well the "previous" link of this new page is not correct: If you click now on "Previous" you will return back to platformio account token" section.

image

Navis-Raven avatar Aug 29 '18 11:08 Navis-Raven

I didn't check all "previous" and "next" buttons it's the first time I see this bug, however it has to be done: Checking the rest of them if there is no other bad next/previous link like this one (for instance by clicking "next" from the beginning to the "end", and after "previous" from the end to the beginning.

Navis-Raven avatar Aug 29 '18 11:08 Navis-Raven

*** UPDATE *** I've seen rapidly some other inconcistencies like the "next" button jumps directly to the next chapter and not like example before, or the countrary (it does not jump som subchapter). So please check these "next" "prevous" button to be sure, it jumps the "jumpable" subchapters and do not jump important chapters.

Navis-Raven avatar Aug 29 '18 22:08 Navis-Raven

this one is still unsolved

Navis-Raven avatar Oct 02 '18 22:10 Navis-Raven

Hm... I think it's an unfortunate side effect of reusing already written documentation...

CLI Guide
---------

.. toctree::
    :maxdepth: 2

    ../userguide/account/index

For want of another better way to resolve this, perhaps instead of just re-purposing the already existing page using a relative link, do a hard file link at the file system level instead? Preserving the navigation system layout, but not having maintain multiple copies of the file?

Edit: Er... Yuck! Forget I said anything... about links... duplicate label issues abound... not such a bright idea. The prev/next navigation is unfortunately true to how the documentation is put together rather than the side-bar navigation... so this should stay in the 'too-hard/not fixing' basket.

pfeerick avatar May 21 '19 05:05 pfeerick