Skip to content

Publishing docs on svelte.dev or highlighting them there #824

Open
@benmccann

Description

@benmccann

Description

We're starting to put together plans to publish docs for all the various plugins directly on svelte.dev (e.g. vite-plugin-svelte, rollup-plugin-svelte, svelte-loader, svelte-preprocess, the VS code plugin, prettier-plugin-svelte, eslint-plugin-svelte, etc.)

eslint-plugin-svelte is much different than the others because it has many more pages as well as an existing site and a playground. This raises several questions:

  • Should we try to incorporate the playground into the main site? It's setup looks a little complicated. I also don't know if that would make things harder for you?
  • Should we just have a single page with setup instructions and then link to the existing site?
  • Or should move all the content over except for the playground?

I've asked these questions of the other maintainers working on the site, but thought it would be good to get your input as well. We'd like to try to have the markdown continue to live in each individual repository and then the site's build and deploy process will check out each of those repositories and use the docs from there. We're working on prototyping that right now. The main change needed here would probably be to publish a bit of config stating what order the pages should show up in the sidebar (e.g. sveltejs/svelte#12410)

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions