Skip to content

Commit 21e5cdc

Browse files
authored
More cleanup after move to pnpm (#1350)
- Remove some more unnecessary files - Update README for docs site ## Checklist - [ ] I have added [tests](https://www.cursorless.org/docs/contributing/test-case-recorder/) - [ ] I have updated the [docs](https://github.com/cursorless-dev/cursorless/tree/main/docs) and [cheatsheet](https://github.com/cursorless-dev/cursorless/tree/main/cursorless-talon/src/cheatsheet) - [ ] I have not broken the cheatsheet
1 parent fad6a06 commit 21e5cdc

File tree

4 files changed

+8
-40
lines changed

4 files changed

+8
-40
lines changed

.vscodeignore

Lines changed: 0 additions & 16 deletions
This file was deleted.

.yarnrc

Lines changed: 0 additions & 1 deletion
This file was deleted.
Lines changed: 8 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,31 @@
1-
# Website
1+
# cursorless.org docs site
2+
3+
This is the source code for the [cursorless.org/docs](https://cursorless.org/docs) portion of the Cursorless website. Note that it is built independently from the rest of the site (which uses Next.js, and can be found in the [`cursorless-org`](../packages/cursorless-org) directory).
24

35
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
46

57
### Installation
68

79
```
8-
$ yarn
10+
pnpm install
911
```
1012

1113
### Local Development
1214

1315
```
14-
$ yarn start
16+
pnpm start
1517
```
1618

1719
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
1820

1921
### Build
2022

2123
```
22-
$ yarn build
24+
pnpm build
2325
```
2426

2527
This command generates static content into the `build` directory and can be served using any static contents hosting service.
2628

27-
### Deployment
28-
29-
Using SSH:
30-
31-
```
32-
$ USE_SSH=true yarn deploy
33-
```
34-
35-
Not using SSH:
36-
37-
```
38-
$ GIT_USER=<Your GitHub username> yarn deploy
39-
```
29+
### Deploy
4030

41-
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
31+
After building this site, we copy the output to the `docs` subdir of the staging directory for our website, which is then deployed by Netlify. See the [deploy script](../../scripts/build-and-assemble-website.sh) for more details.

scripts/update-package.sh

Lines changed: 0 additions & 5 deletions
This file was deleted.

0 commit comments

Comments
 (0)