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.

Sign up for GitHub

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

Jump to bottom

Docs redesign #1

Open
nikolai-cc opened this issue Jul 18, 2022 · 2 comments
Open

Docs redesign #1

nikolai-cc opened this issue Jul 18, 2022 · 2 comments
Labels
📚 docs it's not you it's me
Milestone
1.0

Comments

@nikolai-cc
Copy link
Owner

nikolai-cc commented Jul 18, 2022 •
edited
Loading

/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
@nikolai-cc nikolai-cc added the 📚 docs it's not you it's me label Jul 18, 2022
@nikolai-cc nikolai-cc mentioned this issue Jul 20, 2022
Closed
@nikolai-cc nikolai-cc added this to the 1.0 milestone Jul 21, 2022
@tanepiper
Copy link

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
Copy link
Owner Author

@tanepiper That's definitely part of the plan 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
📚 docs it's not you it's me
Projects
None yet
Milestone
1.0
Development

No branches or pull requests
2 participants
@tanepiper @nikolai-cc