Docs redesign - Githubissues

nikolai-cc / svu

Svelte development, supercharged.

https://svu.vercel.app

MIT License

39 stars 3 forks source link

Docs redesign #1

Open nikolai-cc opened 2 years ago

nikolai-cc commented 2 years ago

/svu docs are very basic as they are now.

Some ideas for the next version:

color code top-level folders
focus on actionable (interactive) examples
add search
add keyboard shortcuts for quick navigation
add chapter markers

Per page:

Document wether a /svu requires SvelteKit
Add a blurb available on other pages
Add interactive examples

edit 20220908 - progress! https://www.figma.com/file/jt4NqtSziLiK1DxuBFiQ2M/svu-Docs-Design-File?node-id=0%3A1

tanepiper commented 1 year ago

Some feedback on the docs - the side navigation is quite difficult to use and not really accessible, can you please simplify the nav and make it more readable?

nikolai-cc commented 1 year ago

@tanepiper That's definitely part of the plan 🙂