docs: Make 0.6.0 docs main documentation

[zoey-kaiser]

Makes the 0.6.0 docs the default docs. Does not remove the 0.5.0 docs to ensure we keep these archived. A follow up Pr on https://github.com/sidebase/docs is required and will be linked here.

Edit: Sister PR can be found here: sidebase/docs#149

[BracketJohn]

I'm a bit overwhelmed byu these changes: What is happening here? Why do we have to switch around all dirs and cannot just point latest to v0.6 and be happy?

[zoey-kaiser]

I'm a bit overwhelmed byu these changes: What is happening here? Why do we have to switch around all dirs and cannot just point latest to v0.6 and be happy?

The problem is, that we had all the old links (on google, other pages etc.) never point to a version of the docs. If we were to leave them in that folder, we would need to update all the links, wait for google to update etc.

This would make a lot of problems. It would have been nicer if we from the very beginning had versioned paths, but as we did not do this, we now have this issue.

[BracketJohn]

I see, but will this be resolved from now on / can we switch to the versioned approach now?

[zoey-kaiser]

I see, but will this be resolved from now on / can we switch to the versioned approach now?

It would either:

• Point all existing links and google searches (for a while until it updates) to a 404 (if we move the old docs into /v0.5)
• Open outdated documentation if we keep the order as it is right now.

I don't think this is something we can tackle today.

[BracketJohn]

Can't we:

• keep current documentation under current path
• start with versioned documentation for v0.6
• also copy the current documentation to v0.5
• point latest to 0.6

? This way:

• we have an upgrade path that leads into versioning
• current users links will not break (there are likely people out there who have bookmarked or linked from their code to our docs, this change would lead them suddenly loading v0.6 docs)

so basically we have:

• /nuxt-auth/v0.6/ <- latest points to this
• /nuxt-auth/v0.5/
• /nuxt-auth/ <- this stays v0.5 for some time (or even better 301 redirects to /v0.5)

Otherwise I do not know if I'm comfortable with this (then rushed) switch, due to it breaking the references many people potentially keep

[BracketJohn]

see above

[zoey-kaiser]

point latest to 0.6

This is something we attempted during the initial versioning PR. The problem I ran into was that I could not create catch all redirects.
What this essentially means:

• I would need to create a md file for every route we used to have in the docs and point each file to the new docs.

I would have loved to have a catch all route that says:

• If link has nuxt-auth/X point to nuxt-auth/v0.6/X, but this is not possible.

See nuxt-themes/docus#829 for the previous investigation.

[BracketJohn]

Ok, and applying this solution without the redirect?

[zoey-kaiser]

Ok, and applying this solution without the redirect?

This would result in many of our old links being inaccessible. This includes google search results until google updates them, which could take a while.

Definitely breaking:

• All the links referenced on the docs page (would need to be updated, however definitly do-able)
• All the twitter links (not do-able)
• Any link posted on our discord (between us or users, not do-able)
• Google search (for a while, as google needs to reindex everything)
• Search (would require a reindex as well, do-able)
• Github issues (would be broken, not do-able)

I am really against this, as we lose a lot of the connections we already have.

[zoey-kaiser]

Added the banner as agreed:

[BracketJohn]

Nit: It should probably be "You are viewing the docs for the newest version. [...]"

[zoey-kaiser]

Nit: It should probably be "You are viewing the docs for the newest version. [...]"

True, good catch