draft: chore: add docs

[manuel3108]

This aims to provide some rough docs ideas in the correct format for the omnisite. I'm really bad at writing such stuff, let's treat this as a collaboration PR 😆

I have added much of the basic things, and added a basic structure. Most of the examples are from the top of my head and i copy pasted a lot. This should just serve to get stuff up and running at this point.

Here is a small video-preview, as getting the omnisite to work is not 100% straightforward, especially because our repo is not yet public

2024-10-08.21-23-05.mp4

[benmccann]

I think we could go ahead and merge these to have something in place. We can always work on updating them more. It might be a bit clearer how to structure them after seeing them deployed

[Rich-Harris]

Not so fast: sveltejs/svelte.dev#293 (comment). The docs need to be syncable at a bare minimum, otherwise this doesn't really get us anything

[dummdidumm]

If it takes too long to do that we should postpone properly syncing the docs until after launch, until then we can just copy over manually.

[Rich-Harris]

On closer review, we don't actually need to read the types because they're not rendered anywhere, so I adjusted the script instead in sveltejs/svelte.dev@12fd112. I'm working on the content now

[benmccann]

Going to merge this for now. Please feel free to send follow-up PRs though