- This project started in reaction to this Discourse thread from November 2016
- This is not a theme; this is a complete overhaul of the Hugo docs, particularly the content component.
- I am looking for feedback on content and not design. The awesome @budparr has already volunteered to help clean up the homepage (it needs some love).
- Please respond to content-related feedback on this thread or submit via GH issue.
- Everything that is a WIP is marked as such on the published page, but I’m still open to substantive feedback on how the content in those pages can be improved.
- As an Irish-American, I will be out all day today celebrating an early St. Patty’s. My earliest responses will be tomorrow afternoon (Sunday, CST).
The Ask of the Hugo Community
- What was the most difficult concept to grok when you first started learning Hugo?
- Gotchas? Logical inconsistencies?
- What are the greatest strengths and weaknesses in the current documentation?
- What’s hard to find? Which parts seem contradictory? Any outdated material?
- W/r/t sections or general areas of this new concept site, do you see any large content gaps?
- When approaching Hugo for the first time, what should the assumptions be about the end user’s skill set, knowledge level, etc?
- All other content-focused feedback is welcome.
Note: All of this will need the blessing and input of @spf13 before it goes anywhere. I would love for the new documentation to ship with v20 and be moved into the Hugo repository.
Just a few of the improvements that are currently springing to mind:
- Search is exponentially better
- “Extras,” currently the largest content section on the site, has been completely removed and incorporated into multiple other areas.
- Semantics are improved across the board…way too much to detail here, but just think “definition list”
- SEO: twitter, OGP, schema.org, shareable default image, and many others…
- Mobile-first: the site’s menu, at least from testing thus far, is much easier to access on smart phones and tablets. If you see a major usability bug here, please submit an issue.
- Content pages are crazy fast. We will inevitably get dinged once I add the GitHub buttons and Google Analytics.
Special thanks to @bep @moorereason @digitalcraftsman @sethm @spf13 @budparr @anthonyfok and any others I might have forgotten for all your input, tutelage, and expertise. I really really appreciate it