search

svelteuidev / svelteui

SvelteUI Monorepo
https://svelteui.dev
MIT License
1.3k stars 62 forks source link

Insufficient documentation for AppShell. #307

Open Beiri22 opened 1 year ago

Beiri22 commented 1 year ago

Link to the page where something isn't quite right

https://www.svelteui.org/core/app-shell

Exact quote of what is wrong

1.) You are importing AppShell, Navbar, Header, Aside, Footer, ShellSection; but only AppShell is described well; Navbar and Appsection get some attention, but it seems incomplete; Header, Aside, Footer are missing. 2.) The first example code does import HeadComponent and NavComponent; but I cannot browse their sources. Adding them might help reconstructing the example.

Are you willing to create pull request with the fix?

No

BeeMargarida commented 1 year ago

Hi! Normally in the docs we try to cut the code in the example so that it does not become too verbose and hard to understand. So, in the case of AppShell, what you see in the code is a simple structure. Some of the components do not exist in SvelteUI, they are there as an example of what you could put there (NavContent, HeadContent, etc).

Regarding the first point, you are right, the docs still need some work.

If you want to see the exact code, you can see in the demos package - https://github.com/svelteuidev/svelteui/blob/main/packages/svelteui-demos/src/demos/core/AppShell/AppShell.demo.usage.svelte. We are thinking of puting a link to the demo code somewhere in the docs.

Beiri22 commented 1 year ago

I would appreciate links to the demos where useful.