Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
benmccann opened this issue Jul 12, 2024 · 1 comment
Open

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

benmccann opened this issue Jul 12, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@benmccann
Copy link
Member

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)

@benmccann benmccann added the enhancement New feature or request label Jul 12, 2024
@ota-meshi
Copy link
Member

Thank you for letting me know.

Or should move all the content over except for the playground?

I like this option 👍

I want to show red markers in the documentation for each rule, so do you think we can introduce twoslash-eslint instead of rule playground?
You can see a working example of twoslash-eslint at the following site:
https://eslint.style/rules/default/array-bracket-newline#always

I think the plugin playground could be directed to another site.

https://eslint-online-playground.netlify.app/#eslint-plugin-svelte%20with%20typescript

ota-meshi pushed a commit that referenced this issue Jul 21, 2024
This PR is part of
#824. It
represents the first step in the omnisite.

In this update, I switched playground to
[eslint-online-playground](https://eslint-online-playground.netlify.app/#eslint-plugin-svelte%20with%20typescript).
The transition to `twoslash-eslint` will be made in the next PR. After
tht I think we can remove all ESLint runners from the documentation site
to simplify the build process.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants