Develop new Quick Start to introduce more recent Hugo features and concepts about hugo-docs-concept HOT 3 OPEN

May just be me, but when I'm checking out software, I just want to DO something. I'm looking less for understanding the whole, but just to see for myself the folder structure and what it takes to get a page running in the browser.

So, to my mind a quickstart should be the absolute bare minimum to get something running, then with pointers to other places in the docs to explain how things work, so, as you've said, there's nothing, or little repeated. Just my 2cents.

from hugo-docs-concept.

What should the goal be for the Quick Start? I wonder about potentially re-explaining concepts that might be better left to good documentation and/or well commented code in the default theme.

For example, the Directory Structure page may be a WIP, but it does exist and it might be better to refer people to it. Same with overriding themes.

If the goal of the Quick Start were to be just to get a site up and running, a potential structure could be:

1. Goals and Assumptions
2. Install Hugo
3. Hugo New Site and Install Default Theme
4. Basic Site configuration
5. Add Content, Serve Locally, and Hugo Build
6. Next Steps

That teaches some of the fundamental concepts, e.g. installing a theme and basic CLI usage. This might run the risk of underexplaining, but this could be avoided if the QS refers people to the relevant portions of the docs or commented code as they follow the guide.

But this all depends on what the goal is and who it is written for.

from hugo-docs-concept.

So, to my mind a quickstart should be the absolute bare minimum to get something running, then with pointers to other places in the docs to explain how things work, so, as you've said, there's nothing, or little repeated.

All my thoughts on a quick start as well...in a nut shell.

I'd really like to see if the default theme takes flight, especially before v20.

I think the default theme and Quick Start should be inseparably wedded without question.

from hugo-docs-concept.