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

Improve guide example #104

Closed
kARAT97 opened this issue Oct 29, 2023 · 1 comment
Closed

Improve guide example #104

kARAT97 opened this issue Oct 29, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@kARAT97
Copy link

kARAT97 commented Oct 29, 2023

My thought is to improve the guide usability with a very simple method, you already have the configuration examples which are great and you have a demo which is also great but I feel like a crucial component there is missing.

You should input a code block into the guide and/or demo site that references the exact configuration utilized in the demo site.
As an example, I'm looking into the same sort of segmentation of sidebars as on the demo site, with the "CSS" "Javascript" and "Markdown index" sections being in bold with rulers above them separating the sidebars but can't easily figure out whether that's performed through the markdown syntax in titles or by utilizing multiple sidebar configuration displayed on the same site.

Having the code snippet used on the demo site would immediately show me how it's performed.

@jooy2 jooy2 added the documentation Improvements or additions to documentation label Nov 1, 2023
@jooy2 jooy2 self-assigned this Dec 12, 2023
@jooy2
Copy link
Owner

jooy2 commented Oct 25, 2024

Hello, thank you for your valuable feedback.

As of 2024, the documentation page has undergone a major overhaul, removing ambiguous descriptions and making it easier to find options.
I don't yet have code examples for each option, but this will be added gradually as needed.

I'm closing this issue because it's more or less up to date and i can't link to an actual commit.
However, i will continue to improve the documentation in the future.

Regards,

@jooy2 jooy2 closed this as completed Oct 25, 2024
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