Skip to content

Commit 9a78ab2

Browse files
committed
updated the contributing.md
1 parent 8131cb1 commit 9a78ab2

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -70,21 +70,22 @@ Our site is build on [SolidStart](https://github.com/solidjs/solid-start). This
7070
### Folder structure
7171

7272
We have two folders of note: **content** and **src**. **content** contains all of the pages and page-specific components. This includes the four content folders corresponding to our [four content types](https://github.com/solidjs/solid-docs-next/blob/main/WRITING.md#content-types):
73-
- `content/tutorials`
74-
- `content/how-to-guides`
75-
- `content/concepts`
76-
- `content/api-reference` (not being worked on currently, as we have the [existing API reference](https://www.solidjs.com/docs/latest/api))
73+
- `content/guides/tutorials`
74+
- `content/guides/how-to-guides`
75+
- `content/guides/foundations`
76+
- `content/references/concepts`
77+
- `content/references/api-reference` (not being worked on currently, as we have the [existing API reference](https://www.solidjs.com/docs/latest/api))
7778

7879

7980
In **src**, we have the SolidStart entry files, the root component, and the `md.tsx` component which maps markdown syntax to elements. Of note:
8081
- `src/components`: General components, like the sidebar navigation, footer, and Asides.
8182
- `src/NAV_SECTIONS.ts`: This file determines the two sidebar navigation sections, **Guides** and **Reference**. **Guides** contains Tutorials and How-To Guides, and **Reference** contains Concept pages and API reference.
8283

83-
Every content page must have its own folder, even if it only has one page. For example, the Tracking concept page is one page, so it is found in an `index.md` file inside `content/concepts/tracking`. The Getting Started with Solid tutorial has several pages, which are found inside `content/tutorials/getting-started-with-solid`.
84+
Every content page must have its own folder, even if it only has one page. For example, the Tracking concept page is one page, so it is found in an `index.md` file inside `content/references/concepts/tracking`. The Getting Started with Solid tutorial has several pages, which are found inside `content/guides/tutorials/getting-started-with-solid`.
8485

85-
These folders will automatically generate routes; so, `content/tutorials/getting-started-with-solid/installing-solid` will be shown at `https://docs.solidjs.com/tutorials/getting-started-with-solid/installing-solid`.
86+
These folders will automatically generate routes; so, `content/guides/tutorials/getting-started-with-solid/installing-solid` will be shown at `https://docs.solidjs.com/guides/tutorials/getting-started-with-solid/installing-solid`.
8687

87-
If a content page has its own custom components and code snippets, place these inside its content folder. See [the Getting Started with Solid folder](https://github.com/solidjs/solid-docs-next/tree/main/src/content/tutorials/getting-started-with-solid) for an example.
88+
If a content page has its own custom components and code snippets, place these inside its content folder. See [the Getting Started with Solid folder](https://github.com/solidjs/solid-docs-next/tree/main/src/content/guides/tutorials/getting-started-with-solid) for an example.
8889

8990
> **Warning** There is also `start` folder in `content/routes`; it is a heavy work-in-progress managed by the SolidStart team and does not yet follow our Writing guide.
9091

0 commit comments

Comments
 (0)