3 ms·

Hugo might have the worst documentation I have ever encountered in the wild. Which, if you think about it, is the height of irony. Hugo, the thing so many peop

Hugo might have the worst documentation I have ever encountered in the wild. Which, if you think about it, is the height of irony. Hugo, the thing so many people use to make documentation, has terrible, terrible documentation. It is impenetrable. This is coming from a Go dev who understands Hugo's internals quite well and uses it in production. Had I known what my journey with Hugo would be like, however, I would have never touched it. In all that time, with all the headaches it caused, I could have just built my own SSG.

trinsic2 2y ago
Oook. I have seen worse. Its been my experience that the documentation is pretty good and the community helps when when there are discrepancies.
- throwaway77385 2y ago
  The community is very good indeed. That was always where I ended up finding answers. I don't know whether I have seen worse. I may have seen 'equally bad', however. There's a good chance that I'm just not good at understanding that style of documentation. I feel there is a huge lack of examples. The examples given are very specific and they do this thing where, when showing two examples of the same functionality, they change all the variable names and data-structures, making it impossible to follow. But that may just be me. Some people might find it useful to see the same example with different data-structures and variable names.
Ferret7446 2y ago
> I could have just built my own SSG That's actually what I did when I tried using Hugo. Go is very well suited for it. https://github.com/darkfeline/felesatra/blob/master/kanade/cmd_render.go https://github.com/darkfeline/felesatra/blob/master/kanade/c...
9dev 2y ago
It’s pure bliss compared to just about any Python library. Oh, you want to know what arguments this function takes? Well, a kwargs dict, duh! Why not just read the full example section to hopefully find some of them?
- tacticus 2y ago
  oh sorry there is no example section. just search github for examples.

trinsic2 2y ago

Oook. I have seen worse. Its been my experience that the documentation is pretty good and the community helps when when there are discrepancies.

throwaway77385 2y ago
The community is very good indeed. That was always where I ended up finding answers. I don't know whether I have seen worse. I may have seen 'equally bad', however. There's a good chance that I'm just not good at understanding that style of documentation. I feel there is a huge lack of examples. The examples given are very specific and they do this thing where, when showing two examples of the same functionality, they change all the variable names and data-structures, making it impossible to follow. But that may just be me. Some people might find it useful to see the same example with different data-structures and variable names.

Ferret7446 2y ago

> I could have just built my own SSG That's actually what I did when I tried using Hugo. Go is very well suited for it. https://github.com/darkfeline/felesatra/blob/master/kanade/cmd_render.go https://github.com/darkfeline/felesatra/blob/master/kanade/c...

9dev 2y ago

It’s pure bliss compared to just about any Python library. Oh, you want to know what arguments this function takes? Well, a kwargs dict, duh! Why not just read the full example section to hopefully find some of them?

tacticus 2y ago
oh sorry there is no example section. just search github for examples.