draft: chore: add docs #71
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
benmccann
reviewed
Oct 8, 2024
benmccann
reviewed
Oct 9, 2024
Co-authored-by: Ben McCann <[email protected]>
Co-authored-by: Ben McCann <[email protected]>
benmccann
reviewed
Oct 9, 2024
benmccann
approved these changes
Oct 9, 2024
|
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 |
|
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. |
|
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
reviewed
Oct 10, 2024
benmccann
reviewed
Oct 10, 2024
|
Going to merge this for now. Please feel free to send follow-up PRs though |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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