Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve structure and examples #567

Open
McShelby opened this issue Jun 12, 2023 · 2 comments
Open

docs: improve structure and examples #567

McShelby opened this issue Jun 12, 2023 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@McShelby
Copy link
Owner

McShelby commented Jun 12, 2023

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 McShelby added the documentation Improvements or additions to documentation label Jun 12, 2023
@McShelby McShelby added this to the 6.0.0 milestone Jun 12, 2023
@McShelby McShelby self-assigned this Jun 12, 2023
@postb99
Copy link

postb99 commented Oct 13, 2023

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?

@McShelby McShelby removed this from the 6.0.0 milestone Apr 18, 2024
@McShelby
Copy link
Owner Author

Soon™

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants