sveltejs / vite-plugin-svelte

Svelte plugin for http://vitejs.dev/
MIT License
837 stars 100 forks source link

Docs on svelte.dev #942

Open benmccann opened 1 month ago

benmccann commented 1 month ago

Describe the problem

There's a desire to put docs for all the projects into the omnisite. vite-plugin-svelte doesn't really have a docs index page currently. There's the readme, but we might put different content on svelte.dev than what's there. There also isn't a clear order the docs pages should be displayed in the lefthand nav

Describe the proposed solution

Prefix the existing docs with 10-, 20-, etc. to provide an ordering that can be used in the lefthand nav. The docs with the smallest prefix should include some introductory material

Alternatives considered

it may be helpful to update the directory structure of various repos to align with each other, but I think that isn't strictly necessary and we can maintain a mapping of where docs live in each repo

Importance

i cannot use vite-plugin-svelte without it

dominikg commented 1 month ago

happy to add a json file providing metadata, renaming files would cause existing links to break and make it harder for humans to parse what they are looking for.

if you insist on ordering by filename a separate omnidocs with symlinks could be created.

dominikg commented 1 month ago

we also have one link self referencing it in a log https://github.com/sveltejs/vite-plugin-svelte/blob/ab2dd120e82edc39632d046bec3553e0da211285/packages/vite-plugin-svelte/src/utils/constants.js#L25