Skip to content

Commit c78be97

Browse files
committed
update contributing guide
1 parent 1fa148d commit c78be97

1 file changed

Lines changed: 14 additions & 13 deletions

File tree

CONTRIBUTING.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -69,27 +69,28 @@ Our site is build on [SolidStart](https://github.com/solidjs/solid-start). This
6969

7070
### Folder structure
7171

72-
The action happens in the `src` folder. Of note:
72+
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))
7377

74-
- `src/components`: General components, like the sidebar navigation, footer, and Asides.
75-
- `src/routes`: Content pages and components that are specific to them. Within are folders corresponding to our [four content types](https://github.com/solidjs/solid-docs-next/blob/main/WRITING.md#content-types):
76-
- `src/routes/tutorials`
77-
- `src/routes/concepts`
78-
- `src/routes/how-to-guides`
79-
- `src/routes/api-reference`
80-
- `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.
8178

82-
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 `routes/concepts/tracking`. The Getting Started with Solid tutorial has several pages, which are found inside `routes/tutorials/getting-started-with-solid`.
79+
In **src**, we have the SolidStart entry files, the root component, and the `md.tsx` component which maps markdown syntax to elements. Of note:
80+
- `src/components`: General components, like the sidebar navigation, footer, and Asides.
81+
- `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.
8382

84-
These folders will automatically generate routes; so, `routes/tutorials/getting-started-with-solid/installing-solid` will be shown at `https://docs.solidjs.com/tutorials/getting-started-with-solid/installing-solid`.
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`.
8584

86-
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/routes/tutorials/getting-started-with-solid) for an example.
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`.
8786

88-
> **Warning** There is also `start` folder in `src/routes`; it is a heavy work-in-progress managed by the SolidStart team and does not follow these rules.
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+
89+
> **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.
8990
9091
### Adding New Content Pages
9192

92-
1. Choose one of the four folders inside `src/routes/`, corresponding to your page's [content type](https://github.com/solidjs/solid-docs-next/blob/main/WRITING.md#content-types)
93+
1. Choose one of the four folders inside `content/`, corresponding to your page's [content type](https://github.com/solidjs/solid-docs-next/blob/main/WRITING.md#content-types)
9394
2. Create a new folder inside that folder. The new folder's name should be the kebab case of your page's title: e.g., `getting-started-with-solid`.
9495
3. Add `mdx` files for each subpage.
9596

0 commit comments

Comments
 (0)