combine readmes into contributing.md

sveltejs · benmccann · Oct 24, 2024 · Oct 25, 2024 · Oct 25, 2024 · Oct 25, 2024
commit 6bf009cbc2321fa9c44a4c238e24156670d0fd5e
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,41 @@
+# Development
+
+## Running
+
+```
+pnpm install
+cd apps/svelte.dev
+USE_GIT=true pnpm sync-docs
+pnpm run dev
+```
+
+## Database setup
+
+Login to [Supabase](https://supabase.com) and create a database. Once done, you should be on your database's dashboard. Duplicate the `.env.example` file and rename it to `.env.local`, and set these environment variables:
+
+- `SUPABASE_URL`: The config URL
+- `SUPABASE_KEY`: The public API key
+
+Then, navigate to your database's "SQL Editor", click on "New query", and paste in [setup.sql](./setup.sql). Run this SQL to seed the database and you're good to go.
+
+## Tutorial
+
+The tutorial consists of two technically different parts: The Svelte tutorial and the SvelteKit tutorial. The SvelteKit tutorial uses [WebContainers](https://webcontainers.io/) under the hood in order to boot up a Node runtime in the browser. The Svelte tutorial uses Rollup in a web worker - it does not use WebContainers because a simple web worker is both faster and more reliable (there are known issues with iOS mobile).
+
+WebContainers require [cross-origin isolation](https://webcontainers.io/guides/quickstart#cross-origin-isolation), which means the document needs to have these headers:
+
+```
+Cross-Origin-Embedder-Policy: require-corp
+Cross-Origin-Opener-Policy: same-origin
+```
+
+The result of setting these headers is that the site can no longer embed URLs from other sites (like images from another domain) without those domains either having a `cross-origin-resource-policy: cross-origin` header (which most don't) or us adding the `crossorigin="anonymous"` attribute (or the experimental-only-working-in-chrome `credentialless` for iframes) to the elements that load those URLs. For this reason, navigations between the SvelteKit tutorial and other pages (and vice versa) are full page navigations so the headers don't interfere with the rest of the page.
+
+When writing content for the tutorial, you need to be aware of the differences of loading content:
+
+- When using root-relative paths, for a SvelteKit exercise the 'root' is the `static` directory inside the exercise itself, but for a Svelte exercise it is the root of the app so assets should do inside `apps/svelte.dev/static/tutorial`.
+- When importing relative assets in a Svelte exercise, Rollup inlines them into the bundle as base64
+
+## Dependencies
+
+If you look in the site's package.json you'll notice several dependencies that don't appear to be used, such as `@testing-library/svelte`. These are present because they're referenced in the docs, and Twoslash needs to be able to find type definitions in order to typecheck snippets. Installing the dependencies was deemed preferable to faking it with `declare module`, since we're liable to end up with fictional types that way.
diff --git a/README.md b/README.md
@@ -14,9 +14,4 @@ The tutorial, blog and examples are maintained within this repository.
 
 ## Setup
 
-```
-pnpm install
-cd apps/svelte.dev
-USE_GIT=true pnpm sync-docs
-pnpm run dev
-```
+See [CONTRIBUTING.md](CONTRIBUTING.md)
diff --git a/apps/svelte.dev/README.md b/apps/svelte.dev/README.md
@@ -14,33 +14,4 @@ The tutorial, blog and examples are maintained within this repository.
 
 ## Development
 
-### Database setup
-
-Login to [Supabase](https://supabase.com) and create a database. Once done, you should be on your database's dashboard. Duplicate the `.env.example` file and rename it to `.env.local`, and set these environment variables:
-
-- `SUPABASE_URL`: The config URL
-- `SUPABASE_KEY`: The public API key
-
-Then, navigate to your database's "SQL Editor", click on "New query", and paste in [setup.sql](./setup.sql). Run this SQL to seed the database and you're good to go.
-
-### Tutorial
-
-The tutorial consists of two technically different parts: The Svelte tutorial and the SvelteKit tutorial. The SvelteKit tutorial uses [WebContainers](https://webcontainers.io/) under the hood in order to boot up a Node runtime in the browser. The Svelte tutorial uses Rollup in a web worker - it does not use WebContainers because a simple web worker is both faster and more reliable (there are known issues with iOS mobile).
-
-WebContainers require [cross-origin isolation](https://webcontainers.io/guides/quickstart#cross-origin-isolation), which means the document needs to have these headers:
-
-```
-Cross-Origin-Embedder-Policy: require-corp
-Cross-Origin-Opener-Policy: same-origin
-```
-
-The result of setting these headers is that the site can no longer embed URLs from other sites (like images from another domain) without those domains either having a `cross-origin-resource-policy: cross-origin` header (which most don't) or us adding the `crossorigin="anonymous"` attribute (or the experimental-only-working-in-chrome `credentialless` for iframes) to the elements that load those URLs. For this reason, navigations between the SvelteKit tutorial and other pages (and vice versa) are full page navigations so the headers don't interfere with the rest of the page.
-
-When writing content for the tutorial, you need to be aware of the differences of loading content:
-
-- When using root-relative paths, for a SvelteKit exercise the 'root' is the `static` directory inside the exercise itself, but for a Svelte exercise it is the root of the app so assets should do inside `apps/svelte.dev/static/tutorial`.
-- When importing relative assets in a Svelte exercise, Rollup inlines them into the bundle as base64
-
-### Dependencies
-
-If you look in the site's package.json you'll notice several dependencies that don't appear to be used, such as `@testing-library/svelte`. These are present because they're referenced in the docs, and Twoslash needs to be able to find type definitions in order to typecheck snippets. Installing the dependencies was deemed preferable to faking it with `declare module`, since we're liable to end up with fictional types that way.
+See [../../CONTRIBUTING.md](CONTRIBUTING.md)