kit icon indicating copy to clipboard operation
kit copied to clipboard

docs: move adapter docs to site

Open benmccann opened this issue 2 years ago • 2 comments

This builds off the docs PRs from @dummdidumm: https://github.com/sveltejs/kit/pull/8501 and https://github.com/sveltejs/kit/pull/8500

I ignored all the types errors in the docs. I don't know if there's a better way to set them up

benmccann avatar Jan 15 '23 00:01 benmccann

🦋 Changeset detected

Latest commit: e782c12ce1643cc6187131914829fb192cdc4123

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 7 packages
Name Type
@sveltejs/adapter-cloudflare-workers Patch
@sveltejs/adapter-auto Patch
@sveltejs/adapter-cloudflare Patch
@sveltejs/adapter-netlify Patch
@sveltejs/adapter-node Patch
@sveltejs/adapter-static Patch
@sveltejs/adapter-vercel Patch

Not sure what this means? Click here to learn what changesets are.

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

changeset-bot[bot] avatar Jan 15 '23 00:01 changeset-bot[bot]

I like this! I think I would rename the first doc to "fundamentals" and would rename the section heading "Build & Deploy", but that's all. Let's wait on more opinions before doing this.

dummdidumm avatar Jan 16 '23 08:01 dummdidumm

I think this is a good approach; will close #8500 and #8501 and do a proper edit of this branch tomorrow

Rich-Harris avatar Jan 18 '23 02:01 Rich-Harris

FYI:

Bad link: adapters#supported-environments-node-js in 20-core-concepts/20-load.md -- 11:18:32.447 | Bad link: adapters#supported-environments-platform-specific-context in 25-build-and-deploy/10-building-your-app.md 11:18:32.460 | Bad link: adapters#supported-environments-platform-specific-context in types/ambient.d.ts

benmccann avatar Jan 18 '23 19:01 benmccann

Really like the structure! Wondering if "static site generation" is the right title since you also can build SPAs with it (a regular point of confusion). Maybe it's even benefitial to have a dedicated page for that? Could be something along the lines of "spas are x, you can create them like y, they are supported by various adapters. If the whole app is an spa, you can use the static adapter, see link for more info (links back to static site generation).

dummdidumm avatar Jan 18 '23 21:01 dummdidumm

Re SPAs — https://github.com/sveltejs/kit/pull/8531#discussion_r1080553330 (you can build an 'SPA' with any adapter, since it describes rendering rather than static-ness). I could be persuaded that we need a new page for SPAs, distinct from build & deploy, as long as it includes 'why you probably shouldn't build an SPA', but i think we can tackle that separately

Rich-Harris avatar Jan 18 '23 21:01 Rich-Harris

I don't like how tall this section is relative to the others — it feels disproportionate. But I don't think there's an easy solution within the current structure so I guess we go along with it for now

image

Rich-Harris avatar Jan 18 '23 22:01 Rich-Harris