docs: new website #5965
docs: new website #5965
Conversation
ldez
force-pushed
the
feat/new-documentation
branch
5 times, most recently
from
7ca3ddf to
1f7d472
Compare
There was a problem hiding this comment.
Do we need to keep the v1 version of the documentation? https://golangci.github.io/legacy-v1-doc/
ldez
force-pushed
the
feat/new-documentation
branch
from
3c17f7c to
f3c9603
Compare
Co-authored-by: Oleksandr Redko <[email protected]>
Co-authored-by: Oleksandr Redko <[email protected]>
ldez
force-pushed
the
feat/new-documentation
branch
from
f3c9603 to
d9842d4
Compare
There was a problem hiding this comment.
Super good work with the new page, feels very nice and easy to work with and looks great! New search is awesome and some really good cross linking!
I didn't spend much time of the content since I see most of it is just moved. I mostly just ran the site locally and pressed every button and menu item to brows through it all!
I think my only real concern or question would be around the /docs path in the URL which doesn't make sense to me (it's all just docs) but not a big deal if it's not an easy fix.
| @@ -11,9 +11,9 @@ body: | |||
| required: true | |||
| - label: Yes, I've searched similar [issues on GitHub](https://github.com/golangci/golangci-lint/issues) and didn't find any. | |||
| required: true | |||
| - label: Yes, I've read the `typecheck` section of the [FAQ](https://golangci-lint.run/welcome/faq/#why-do-you-have-typecheck-errors). | |||
| - label: Yes, I've read the `typecheck` section of the [FAQ](https://golangci-lint.run/docs/welcome/faq/#why-do-you-have-typecheck-errors). | |||
There was a problem hiding this comment.
I don't know too much about Hugo but is this new /docs part of the path due to the folder being docs? Can it be removed? As far as I can tell the only page not under /docs is the landing page. If we could drop /docs which is basically the whole site content less links would be broken and URLs would be shorter.
There was a problem hiding this comment.
The /docs is related to the theme, but this is something positive because we also have /blog, so we will be able to publish tutorials, announcements, etc.
There was a problem hiding this comment.
Also, globally, all the themes have a landing page and /docs/.
I spent a lot of time looking for themes: it was a recurring task for 2 years.
I dug into GitHub and obscure websites, and good themes are extremely rare.
To define what I call a "good theme":
- good looking
- good internal design (maintainability and extensibility)
- Uses go modules and not git submodules
- No need for npm
- Maintained
I tried a lot of Hugo themes, but most of them don't fit our needs.
I found hextra: the features and the style are "extra" 😸
There are some constraints for the search feature, so I split some pages.
I also improved the page contents and adapted the scripts.
I think I will replace the scripts in the future with Hugo partials or shortcodes.
Note: URLs are different from the previous site.
URLs
TLDR: adds the path prefix
/docs2025-08-03.mp4
Fixes #2288
Fixes #1144
Related to #4947
Related to #5633
Related to #5943
Related to #5725
Related to #3191