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

docs: mention the types without types feature #9397

Merged
merged 3 commits into from
Mar 15, 2023

Conversation

dummdidumm
Copy link
Member

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests

  • Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Changesets

  • If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

@benmccann
Copy link
Member

I wonder if we should change the other docs and create-svelte to remove the usage of $types and then in the IDE section say you'll need to use $types if you want to use something other than VS Code?

@dummdidumm
Copy link
Member Author

I'm against this. In the docs these types provide valuable context to me. And since not all IDEs - intellij in particular - can't take advantage of it, it would be confusing for those who can't use it

@benmccann
Copy link
Member

Yeah, you have me convinced. Referencing the type is helpful just for understanding the type of things when reading the docs

The other thing I wonder is if this should go under "Editor setup" rather than the routing section

@dummdidumm
Copy link
Member Author

Why_not_both.gif

Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com>
@benmccann benmccann merged commit 5d9c670 into master Mar 15, 2023
@benmccann benmccann deleted the types-with-types-mention branch March 15, 2023 21:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants