Skip to content

Commit b884a29

Browse files
authored
chore: add base readme with basic contributing docs (#559)
1 parent ec26507 commit b884a29

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# svelte.dev
2+
3+
This is the repository behind [svelte.dev](https://svelte.dev), the official Svelte site, and the related packages that it relies on.
4+
5+
## Documentation PRs
6+
7+
If you're creating a documentation PR, make sure you're targeting the right repository. More specifically, changes to content within `apps/svelte.dev/content/docs` are synced from other repositories, and documentation changes within those folder should therefore be made in those repositories:
8+
9+
- `docs/svelte` -> https://github.com/sveltejs/svelte
10+
- `docs/kit` -> https://github.com/sveltejs/kit
11+
- `docs/cli` -> https://github.com/sveltejs/cli
12+
13+
The tutorial, blog and examples are maintained within this repository.
14+
15+
## Setup
16+
17+
```
18+
pnpm install
19+
cd apps/svelte.dev
20+
USE_GIT=true pnpm sync-docs
21+
pnpm run dev
22+
```

0 commit comments

Comments
 (0)