Skip to content

add banner discouraging people from editing generated files #966

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

Merged
merged 2 commits into from
Dec 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Overview
---

Expand Down
1 change: 1 addition & 0 deletions apps/svelte.dev/content/docs/cli/10-introduction/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Introduction
---
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: sv create
---

Expand Down
1 change: 1 addition & 0 deletions apps/svelte.dev/content/docs/cli/20-commands/20-sv-add.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: sv add
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: sv check
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: sv migrate
---

Expand Down
1 change: 1 addition & 0 deletions apps/svelte.dev/content/docs/cli/20-commands/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Commands
---
1 change: 1 addition & 0 deletions apps/svelte.dev/content/docs/cli/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: CLI
---
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Introduction
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Creating a project
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Project structure
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Web standards
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Getting started
---
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Routing
---

Expand Down Expand Up @@ -169,7 +170,7 @@ To create a layout that applies to every page, make a file called `src/routes/+l
...but we can add whatever markup, styles and behaviour we want. The only requirement is that the component includes a `@render` tag for the page content. For example, let's add a nav bar:

```svelte
<!--- file: src/routes/+layout.svelte --->
<!---- file: src/routes/+layout.svelte --->
<script>
let { children } = $props();
</script>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Loading data
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Form actions
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Page options
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: State management
---

Expand Down
1 change: 1 addition & 0 deletions apps/svelte.dev/content/docs/kit/20-core-concepts/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Core concepts
---
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Building your app
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Adapters
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Zero-config deployments
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Node servers
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Static site generation
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Single-page apps
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Cloudflare Pages
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Cloudflare Workers
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Netlify
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Vercel
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Writing adapters
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Build and deploy
---
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Advanced routing
---

Expand Down
1 change: 1 addition & 0 deletions apps/svelte.dev/content/docs/kit/30-advanced/20-hooks.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Hooks
---

Expand Down
1 change: 1 addition & 0 deletions apps/svelte.dev/content/docs/kit/30-advanced/25-errors.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Errors
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Link options
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Service workers
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Server-only modules
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Snapshots
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Shallow routing
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Packaging
---

Expand Down
1 change: 1 addition & 0 deletions apps/svelte.dev/content/docs/kit/30-advanced/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Advanced
---
5 changes: 3 additions & 2 deletions apps/svelte.dev/content/docs/kit/40-best-practices/03-auth.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Auth
---

Expand All @@ -18,6 +19,6 @@ Auth [cookies](@sveltejs-kit#Cookies) can be checked inside [server hooks](hooks

## Guides

[Lucia](https://lucia-auth.com/) is a reference for session-based web app auth. It contains example code snippets and projects for implementing session-based auth within SvelteKit and other JS projects. You can add code which follows the Lucia guide to your project with `npx sv create` when creating a new project or `npx sv add lucia` for an existing project.
[Lucia](https://lucia-next.pages.dev/) is a reference for session-based web app auth. It contains example code snippets and projects for implementing session-based auth within SvelteKit and other JS projects. You can add code which follows the Lucia guide to your project with `npx sv create` when creating a new project or `npx sv add lucia` for an existing project.

An auth system is tightly coupled to a web framework because most of the code lies in validating user input, handling errors, and directing users to the appropriate next page. As a result, many of the generic JS auth libraries include one or more web frameworks within them. For this reason, many users will find it preferrable to follow a SvelteKit-specific guide such as the examples found in [Lucia](https://lucia-auth.com/) rather than having multiple web frameworks inside their project.
An auth system is tightly coupled to a web framework because most of the code lies in validating user input, handling errors, and directing users to the appropriate next page. As a result, many of the generic JS auth libraries include one or more web frameworks within them. For this reason, many users will find it preferrable to follow a SvelteKit-specific guide such as the examples found in [Lucia](https://lucia-next.pages.dev/) rather than having multiple web frameworks inside their project.
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Performance
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Images
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Accessibility
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: SEO
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Best practices
---
1 change: 1 addition & 0 deletions apps/svelte.dev/content/docs/kit/60-appendix/10-faq.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Frequently asked questions
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Integrations
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Breakpoint Debugging
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Migrating to SvelteKit v2
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Migrating from Sapper
rank: 1
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Additional resources
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Glossary
---

Expand Down
1 change: 1 addition & 0 deletions apps/svelte.dev/content/docs/kit/60-appendix/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: Appendix
---
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: @sveltejs/kit
---

Expand Down Expand Up @@ -132,7 +133,9 @@ Checks whether this is an action failure thrown by `fail`.
<div class="ts-block">

```dts
function isActionFailure(e: unknown): e is ActionFailure;
function isActionFailure(
e: unknown
): e is ActionFailure<undefined>;
```

</div>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: @sveltejs/kit/hooks
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: @sveltejs/kit/node/polyfills
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: @sveltejs/kit/node
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: @sveltejs/kit/vite
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: $app/environment
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: $app/forms
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
NOTE: do not edit this file, it is generated in apps/svelte.dev/scripts/sync-docs/index.ts
title: $app/navigation
---

Expand Down
Loading
Loading