Skip to content

docs: expand Config types on vite reference page - #17041

Merged
teemingc merged 2 commits into
sveltejs:version-3from
marwan562:docs/17028-configuration-docs
Sep 8, 2026
Merged

teemingc merged 2 commits into
sveltejs:version-3from
marwan562:docs/17028-configuration-docs

Conversation

@marwan562

Copy link
Copy Markdown
Contributor

closes #17028

2c4e73d moved Config to @sveltejs/kit/vite and deleted the configuration page with it, so the docs lost the left-nav entry and the per-option On-this-page anchors (everything collapsed under a single #Config). This puts the page back, pointing EXPANDED_TYPES at @sveltejs/kit/vite#Config. The 31 existing (configuration#...) links in 18 files resolve again.

Heads up: svelte.dev sync-docs still looks for Config/KitConfig in @sveltejs/kit, so it'll need a companion tweak to read Config from @sveltejs/kit/vite (it throws before preprocess runs on version-3). Happy to follow up there.


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:`.

Edits

  • Please ensure that 'Allow edits from maintainers' is checked. PRs without this option may be closed.

@pkg-svelte-dev

pkg-svelte-dev Bot commented Sep 5, 2026 •

Copy link
Copy Markdown

Install the latest version of @sveltejs/kit from 2016f06:

pnpm add https://pkg.svelte.dev/@sveltejs/kit/c/2016f060129044a5730649e077733cf0c124727a

Open in pkg.svelte.dev: https://pkg.svelte.dev/repos/kit/pr/17041

Note

This PR is from a fork. A maintainer must approve approve each commit before it can be built and installed.

@changeset-bot

changeset-bot Bot commented Sep 5, 2026 •

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 2016f06

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai

coderabbitai Bot commented Sep 5, 2026 •

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: QUIET

Plan: Advanced

Run ID: d24ec458-2a71-4929-bb13-2fdab154413e

📥 Commits

Reviewing files that changed from the base of the PR and between e7ca9aa and 2016f06.

📒 Files selected for processing (1)
  • documentation/docs/98-reference/15-@sveltejs-kit-vite.md

📝 Walkthrough

Walkthrough

The @sveltejs/kit/vite reference now includes a sveltekit section with EXPORT_SNIPPET metadata. It also includes a Config section with EXPANDED_TYPES metadata.

Severity of issue fixed: Low

Merge Risk: 🔵 Low · up to e7ca9

The Config type reference metadata is restored, but a remaining Markdown lint warning in the page can prevent documentation validation from completing cleanly.

🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Backward Compatibility Impact Disclosure ✅ Passed PASS: The pull request changes only documentation/docs/98-reference/15-@sveltejs-kit-vite.md by adding EXPANDED_TYPES: @sveltejs/kit/vite#Config. The parent-to-HEAD diff contains no export, reques…
Title check ✅ Passed The title uses the required docs: prefix and clearly describes the change to expand Config types on the Vite reference page.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@teemingc teemingc added the documentation Improvements or additions to documentation label Sep 6, 2026
@svelte-docs-bot

Copy link
Copy Markdown

@teemingc

teemingc commented Sep 7, 2026 •

Copy link
Copy Markdown
Member

Heads up: svelte.dev sync-docs still looks for Config/KitConfig in @sveltejs/kit, so it'll need a companion tweak to read Config from @sveltejs/kit/vite (it throws before preprocess runs on version-3). Happy to follow up there.

I think that's been removed in the next branch for svelte.dev but there's also a redirect away from /configuration to the SvelteKit Vite types https://github.com/sveltejs/svelte.dev/blob/cec8e7468969dde057dbb597fef4977ac094174b/apps/svelte.dev/src/hooks.server.js#L43 maybe it would be better to expand the types on that page to get the headings in the sub nav instead of restoring the old page

@teemingc teemingc left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@marwan562 marwan562 changed the title docs: restore configuration reference page docs: expand Config types on vite reference page Sep 7, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note

Quiet mode is enabled, so only the most important comments were posted inline. Other review comments are grouped below.

🟡 Other comments (1)
documentation/docs/98-reference/15-@sveltejs-kit-vite.md-6-6 (1)

6-6: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Remove the blank line between the metadata directives.

markdownlint reports MD028 at Line 6. Keep the MODULE and EXPANDED_TYPES directives in one contiguous blockquote.

Proposed fix
 > MODULE: `@sveltejs/kit/vite`
-
 > EXPANDED_TYPES: `@sveltejs/kit/vite`#Config

Source: Linters/SAST tools


ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: QUIET

Plan: Advanced

Run ID: e03a8f55-9861-4fb2-a445-86e90bc78f69

📥 Commits

Reviewing files that changed from the base of the PR and between 4ca8b50 and 1dc90a4.

📒 Files selected for processing (1)
  • documentation/docs/98-reference/15-@sveltejs-kit-vite.md
🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

  • sveltejs/vite-plugin-svelte (manual)
  • vitejs/vite (manual)
  • sveltejs/svelte (manual)

Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review.

@marwan562
marwan562 force-pushed the docs/17028-configuration-docs branch from 1dc90a4 to f61f6da Compare September 7, 2026 20:14
@marwan562 marwan562 changed the title docs: expand Config types on vite reference page docs: restore configuration reference page Sep 7, 2026
Comment thread documentation/docs/98-reference/15-@sveltejs-kit-vite.md
Add EXPANDED_TYPES for @sveltejs/kit/vite#Config so each option gets its own heading in On-this-page.

Follows review feedback to expand on the vite page instead of restoring 50-configuration.md. The existing /docs/kit/configuration redirect to @sveltejs-kit-vite preserves hashes, so old configuration#... links land on the expanded sections.

Closes sveltejs#17028
@marwan562
marwan562 force-pushed the docs/17028-configuration-docs branch from 3f743e3 to e7ca9aa Compare September 7, 2026 20:42
@marwan562 marwan562 changed the title docs: restore configuration reference page docs: expand Config types on vite reference page Sep 7, 2026
Comment thread documentation/docs/98-reference/15-@sveltejs-kit-vite.md Outdated

@teemingc teemingc left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@teemingc
teemingc merged commit f3ec419 into sveltejs:version-3 Sep 8, 2026
4 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Configuration docs

2 participants