Skip to content

Commit b483c59

Browse files
committed
Rename docs back to website
- I'm not constrained to the folder name "docs" if I'm deploying using the gh-pages npm package, copying files to the gh-pages branch. - Had to run `npm i` twice for the package-lock.json changes to make any sense. And it's still leaving `extraneous` entries around.
1 parent 11f975e commit b483c59

10 files changed

+10
-11
lines changed

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -40,21 +40,19 @@ To test the Eye Gaze Mode properly, I needed a facial mouse, but eye trackers ar
4040

4141
## Software Architecture
4242

43-
This is a monorepo containing npm workspaces for the library (`core`), the desktop app (`desktop-app`), and the website (`docs`).
43+
This is a monorepo containing npm workspaces for the library (`core`), the desktop app (`desktop-app`), and the website (`website`).
4444

4545
### Website
4646

4747
The website uses symlinks to reference the library (`core`) and shared resources (`images`) during development.
4848

49-
When deploying with `npm run deploy -w docs`, the symlinks are dereferenced using `cp -rL`.
49+
When deploying with `npm run deploy -w website`, the symlinks are dereferenced using `cp -rL`.
5050

5151
The website is deployed to GitHub Pages using the [`gh-pages`](https://www.npmjs.com/package/gh-pages) npm package.
5252

53-
GitHub Pages supports symlinks, but not to paths outside of `docs` when deploying `docs` as the site root, unfortunately,
53+
(GitHub Pages supports symlinks, but not to paths outside of `docs` when deploying `docs` as the site root, unfortunately,
5454
hence I can't use symlinks to reference the library and avoid a deployment script, while keeping a clean repository structure.
55-
I would have to have the website files at the root of the repository, which I don't want.
56-
57-
Since I'm using `gh-pages`, I no longer need to name the folder `docs` at least though... I can change it back to `website`...
55+
I would have to have the website files at the root of the repository.)
5856

5957
### Desktop App
6058

@@ -104,7 +102,7 @@ MIT-licensed, see [LICENSE.txt](./LICENSE.txt)
104102
- Open up a command prompt / terminal in the project directory.
105103
- Run `npm install`
106104
- Run `npm -w core install` (`-w` is short for `--workspace`, and can be used with many npm commands to target a workspace)
107-
- Run `npm -w docs start` to start a web server that will automatically reload when files change.
105+
- Run `npm -w website start` to start a web server that will automatically reload when files change.
108106
- For the electron app:
109107
- Then `npm -w desktop-app install`
110108

package-lock.json

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

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"workspaces": [
77
"core",
88
"desktop-app",
9-
"docs"
9+
"website"
1010
],
1111
"scripts": {
1212
"lint": "cspell-cli lint . && eslint"
File renamed without changes.

docs/core renamed to website/core

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)