[Docs] Project Structure #4829
[Docs] Project Structure #4829
Conversation
|
|
|
||
| Typicall structure of SvelteKit project is something like: | ||
|
|
||
| ```sh |
There was a problem hiding this comment.
Not sure what to use so comments are shown as comments but everything else as standard text.
There was a problem hiding this comment.
What about using the skeleton app structure, and speaking about option folders like params or generated folders like .svelte-kit/ and build/ when speaking about them in their parents' descriptions?
This is the output I've got using tree (tree -aC --dirsfirst --gitignore added / manually):
├── src/
│ ├── routes/
│ │ └── index.svelte
│ ├── app.d.ts
│ └── app.html
├── static/
│ └── favicon.png
├── tests/
│ └── test.js
├── .eslintrc.cjs
├── .gitignore
├── .npmrc
├── .prettierrc
├── README.md
├── jsconfig.json
├── package.json
├── playwright.config.js
└── svelte.config.jsThere was a problem hiding this comment.
I think it's better if all of important files are included, so it's really fast visible to where put for example params/ folder, that doesn't exist yet without need to search it deeper in docs.
There was a problem hiding this comment.
I agree, that's a very important folder of which, BTW, I didn't know about.
But I would keep it super simple to avoid to overwhelm the reader with "advanced" information, still mentioning them in their related section in the documentation page.
In this case, the section where we explain what the src/ folder is about.
Makes sense?
There was a problem hiding this comment.
I think it's better to have it all at one place together visible,... it doesn't really add that much mess and it's quite visible which files are where.
There was a problem hiding this comment.
Thinking about it, that's true. For sure, I've already learned something new looking at it.
Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com>
Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com>
Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com>
Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com>
Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com>
|
closed in favour of #5430 — thanks for getting the ball rolling |
fixes #4748
rendered
Please don't delete this checklist! Before submitting the PR, please make sure you do the following:
Tests
pnpm testand lint the project withpnpm lintandpnpm checkChangesets
pnpx changesetand following the prompts. All changesets should bepatchuntil SvelteKit 1.0