sigstore / docs

Sigstore documentation
https://sigstore.dev
MIT License
75 stars 81 forks source link

Remove docs from URL path #231

Closed smythp closed 1 year ago

smythp commented 1 year ago

Description

As raised by @normal-coder in #229, the Hugo update added an additional "docs" level to the URL structure. While this is how the Doks theme is set up, it's semantically superfluous, considering that the entire site is a docs site.

Proposed Fix

I will remove docs from the content folder structure. Because Doks relies on this for templating, I will need to add front matter to all content indicating which template to use. I will also need to update the docs archetype so that any new pages use the new front matter format. Finally, I'll need to manually change how the left sidebar works, since it relies by default on the presence of the docs folder.

Benefits

The benefits will be a shorter and more semantic URL structure. Most inbound links will have been invalidated by the recent content reorg, but any that are the same will also be preserved.