hugo-theme-relearn icon indicating copy to clipboard operation
hugo-theme-relearn copied to clipboard

docs: improve structure and examples

Open McShelby opened this issue 1 year ago • 3 comments

The structure has far outgrown its features.

Usually you are searching for a specific thing to achieve like in a "How to" while the docs are more a sequential arbitrary sorted list of references.

By visually deconstructing the UI into smaller parts and providing more screenshots for the different config options, it should be easier for a user to discover information of interest

https://www.youtube.com/watch?v=qC1OYK5oqDo

McShelby avatar Jun 12 '23 17:06 McShelby

Somthing that may currently be useful and not that long to implement: move paragraphs of Customization to children pages so that they can be easily browsed. https://mcshelby.github.io/hugo-theme-relearn/basics/customization/index.html

Does milestone 6.0.0 have any probable date set?

postb99 avatar Oct 13 '23 11:10 postb99

Soon™

But with reduced features. The docs rework was dropped to speed things up. Anyways this is not off the table.

McShelby avatar Apr 18 '24 22:04 McShelby

While adding documentation for 7.0.0, it got evident that this issue needs to be done now. Stay tuned.

McShelby avatar Sep 21 '24 10:09 McShelby