Live data from Hacker News

Hugo is awesome, its documentation is not

sagar.se

81–90 of 128 posts

Re: Hugo is awesome, its documentation is not

#81
post #70

I like Hugo quite a lot, but I don't like Go's standard library templates. I wonder if it is possible to use https://github.com/valyala/quicktemplate with Hugo?

Zola [1] was created exactly for this reason. It even says so in the Readme. The templates are based on Jinja though, not mako. They also claim that their CLI is intuitive and documentation is good. I certainly found it more comprehensible than Hugo's. [1] https://www.getzola.org/

I switched from Hugo to Zola. Happy as Larry.

Re: Hugo is awesome, its documentation is not

#82
post #26

Earlier quoted context omitted.

How would you suggest to write a title that’s less inflammatory? I have a higher tolerance to this type of language. Some people find any critique offensive. Some embrace it. With any public confrontation, you’re bound to get a spectrum of people with various reactions. How do we make sure criticism, even harsh, needs space in public dialog whether it is open source or not? If it’s meant with good faith, that is. Peo…

Instead of "sucks", how about any of these: * My Frustrations with Hugo's Documentation * How Hugo's Documentation Confuses Me and How to Improve It * Why I Don't Like Hugo's Documentation The key thing I've done here in the first three is to reframe the criticism as an _opinion_ ("I", "me", "my") rather than an absolute ("it sucks"). I don't think it's too much to ask people to state their opinions _as opinions_ in…

As written it seems to me the intent of the article is to publicly shame the open source devs who contribute their time and effort into doing more work for free.

It's typical open source toxicity.

Re: Hugo is awesome, its documentation is not

#85
As another poster said, the problem is that Hugo is built around a number of new concepts. To understand them, you have to understand their relation to two contexts: the other Hugo concepts that they are designed to work with, and Hugo's purpose of generating web sites from data.

The docs are written almost entirely in the first context, building the concepts up and explaining how they work together, so if you start with the docs you can end up spending a lot of time trying to create a mental model entirely out of these concepts, with no connection to the concrete function of the software.

Re: Hugo is awesome, its documentation is not

#88
post #29

Thinking about the four kinds of documentation [1], it seems like the Hugo docs are structured as a reference but presented as an explanation/tutorial. I've found it useful to sit down and explicitly think about the purpose of a piece of documentation before writing it, and then write it with that purpose in mind. It sounds like a basic thing, but it's also the main reason people write bad documentation [1] https://d…

I have brought up this exact point on the Hugo forum before [0]. Hugo would become much more accessible if the documentation would be split into the four categories mentioned in the link you provide. This way of thinking about documentation should be the default, and any open source project (or closed for that matter) would benefit hugely by adhering to these simple principles! 0: Discussion: https://discourse.gohugo…

I tried to start a discussion about documentation as reference vs. tutorials on the forums too: https://discourse.gohugo.io/t/discussion-of-hugo-theme-from-...

I think the problem is just that no one wants to bell the cat. :-(

Re: Hugo is awesome, its documentation is not

#89
post #54
post #26

Earlier quoted context omitted.

Instead of "sucks", how about any of these: * My Frustrations with Hugo's Documentation * How Hugo's Documentation Confuses Me and How to Improve It * Why I Don't Like Hugo's Documentation The key thing I've done here in the first three is to reframe the criticism as an _opinion_ ("I", "me", "my") rather than an absolute ("it sucks"). I don't think it's too much to ask people to state their opinions _as opinions_ in…

It's a shame we can't peek into alternate universes to prove/disprove but I have to imagine those titles wouldn't have nearly as many upvotes

You're probably right, but I think not being a jerk should trump HN upvotes.
Post reply on HN