hugoDocs icon indicating copy to clipboard operation
hugoDocs copied to clipboard

Hugo's documentation is difficult to read

Open codlin opened this issue 4 years ago • 2 comments
trafficstars

Hugo's documentation is difficult to read. Here is a proposal. I hope that the team will invent as few professional vocabulary as possible when writing documents, and try to use simple vocabulary to express the meaning. This will help Hugo spread among non-native English speakers.

codlin avatar Oct 06 '21 06:10 codlin

It would probably be more helpful if you provided some examples of what you're having difficulty reading. Hugo is software, so I'm thinking one should expect some professional vocabulary. Just my two cents...

Linux-Geezer avatar Dec 28 '21 14:12 Linux-Geezer

@Linux-Geezer @jmooring I am a new user of hugo. Frankly, It's so diffcult for me to understand the document. For example, at https://gohugo.io/templates/lookup-order/#examples-layout-lookup-for-regular-pages What is the meaning of "Regular Pages"? What is the difference between 'Single page in "posts" section' and 'Single page in "posts" section with layout set'?

Finally I turn to jekyll. When I read jekyll document, I can qucikly understand how to build a site. When I come back to hugo, I understand better because I have read the jekyll document.

There is a guide for how to write a document for Spring. https://github.com/spring-io/spring-asciidoctor-backends/blob/main/guides/style-guide.adoc#the-goal-and-the-audience

I think hugo should focus on the ducument right now other than the more complex technolgy if hugo want to go further.

libinglong avatar Feb 05 '22 15:02 libinglong

Jekyll was a bliss to use because the documentation was flawless. Hugo's issue is that it is so versatile, that the many ways of doing one thing creates a confusion for many a new users.

eih64225 avatar Nov 20 '22 20:11 eih64225

@genetikdisoda

Each of your comments generates a notification for everyone on the team and everyone watching the repository. Please make sure you are adding value.

jmooring avatar Nov 20 '22 21:11 jmooring

I am. Otherwise I wouldn't be checking the issues. Or do you police how many comments users make? I am outta here either way.

eih64225 avatar Nov 20 '22 22:11 eih64225

Thanks for the feedback.

bep avatar Nov 20 '22 22:11 bep