Skip to content

Commit dd4388d

Browse files
committed
wip
1 parent b1f2a7e commit dd4388d

3 files changed

Lines changed: 25 additions & 25 deletions

File tree

.npmrc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
ignore-workspace-root-check=true
2+
auto-install-peers=false

README.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Welcome to Solid's documentation!
66

7-
This is the repo for [docs.solidjs.com](https://docs.solidjs.com/). This repo
7+
This is the repo for [docs.solidjs.com](https://docs.solidjs.com/). This repo
88
contains all the source code that we use to build our docs.
99

1010
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/solidjs/solid-docs-next)
@@ -37,9 +37,9 @@ Have you noticed something is missing, confusing, or is wrong in our
3737
documentation?
3838

3939
Check to see if it has
40-
[already been mentioned ](https://github.com/solidjs/solid-docs-next/issues)
40+
[already been mentioned ](https://github.com/solidjs/solid-docs/issues)
4141
and, if not,
42-
[create an issue](https://github.com/solidjs/solid-docs-next/issues/new/choose)
42+
[create an issue](https://github.com/solidjs/solid-docs/issues/new/choose)
4343
to bring it to our attention!
4444

4545
## Share an idea
@@ -51,7 +51,7 @@ Discussion threads are where you can offer feedback on things that might not be
5151
problems that need addressing, but are ideas to be explored.
5252

5353
Join us in the
54-
[Discussions section](https://github.com/solidjs/solid-docs-next/discussions/280)
54+
[Discussions section](https://github.com/solidjs/solid-docs/discussions/280)
5555
where we can brainstorm these ideas, ask questions, and share goals!
5656

5757
## Suggest a fix or contribute
@@ -62,19 +62,19 @@ If you can see what the problem is, and you know how to fix it, you can make a
6262
PR (pull request) with the change and contribute to the docs repo yourself.
6363

6464
If you're looking to make a larger contribution, please see our
65-
[CONTRIBUTING.md](https://github.com/solidjs/solid-docs-next/blob/main/CONTRIBUTING.md)
65+
[CONTRIBUTING.md](https://github.com/solidjs/solid-docs/blob/main/CONTRIBUTING.md)
6666
first!
6767

6868
## Running the Site Locally
6969

7070
At the moment, we recommend running the site locally through either
71-
[CodeSandbox](https://codesandbox.io/p/github/solidjs/solid-docs-next/),
72-
[Gitpod](https://gitpod.io/#https://github.com/solidjs/solid-docs-next), or
73-
[StackBlitz](https://stackblitz.com/github/solidjs/solid-docs-next). These are
71+
[CodeSandbox](https://codesandbox.io/p/github/solidjs/solid-docs/),
72+
[Gitpod](https://gitpod.io/#https://github.com/solidjs/solid-docs), or
73+
[StackBlitz](https://stackblitz.com/github/solidjs/solid-docs). These are
7474
the quickest and easiest way to browse and edit the project files and run the
7575
site locally.
7676

77-
The app uses [pnpm](https://pnpm.io) as the package manager and it runs on Node.js `v18+`.
77+
The app uses [pnpm](https://pnpm.io) as the package manager and it runs on Node.js `v22+`.
7878

7979
Install dependencies:
8080

@@ -90,9 +90,7 @@ pnpm dev
9090

9191
This will start your the app at [localhost:3000](http://localhost:3000) or the next available port.
9292

93-
### Collections and virtual modules
93+
### Framework and Theme
9494

95-
The builds an [Astro](https://docs.astro.build/en/guides/content-collections/) inspired collection navigation, it will bring all routes and generate a couple of files at `/.solid`.
96-
These files are exposed to your app via [Vite virtual modules](https://vitejs.dev/guide/api-plugin#virtual-modules-convention). This task is perform via our `sync` script (`pnpm sync`), ran before every build.
97-
98-
If changes are made to the navigation (new entry, or repositioning entry), it is necessary to restart the server for changes to take effect.
95+
The docs are built on [SolidBase](https://solidbase.dev) and uses the [Osmium Theme](./osmium).
96+
This repo should only contain content as mdx files, features should be implemented upstream and UI changes in the theme.

pnpm-lock.yaml

Lines changed: 11 additions & 11 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)