Skip to content

Commit 1f48356

Browse files
authored
remove storybook, tasks, and dependencies (#2593)
1 parent 327d167 commit 1f48356

25 files changed

+9
-3177
lines changed

.github/workflows/deploy-docsite.yml

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
name: Docsite and Storybook CI/CD
1+
name: Docsite CI/CD
22

3-
run-name: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' && 'Build and Deploy' || 'Test Build' }} Docsite and Storybook
3+
run-name: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' && 'Build and Deploy' || 'Test Build' }} Docsite
44

55
env:
66
NODE_VERSION: 22
@@ -10,7 +10,7 @@ on:
1010
branches:
1111
- main
1212
workflow_dispatch:
13-
# Also run any time a PR is opened targeting the docs or storybook resources
13+
# Also run any time a PR is opened targeting the docs
1414
pull_request:
1515
branches:
1616
- main
@@ -21,9 +21,6 @@ on:
2121
- ready_for_review
2222
paths:
2323
- "docs/**"
24-
- "storybook/**"
25-
- "**/*.story.*"
26-
- "**/*.stories.*"
2724
- ".github/workflows/deploy-docsite.yml"
2825
- "Taskfile.yml"
2926

.storybook/custom-addons/theme/register.ts

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

.storybook/global.css

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

.storybook/main.ts

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

.storybook/preview.tsx

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

.storybook/theme.ts

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

CONTRIBUTING.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,6 @@ We have a set of recommended Visual Studio Code extensions to enforce our style
3939

4040
To build and run Wave locally, see instructions at [Building Wave Terminal](./BUILD.md).
4141

42-
### UI Component Library
43-
44-
We are working to document all our UI components in [Storybook](https://storybook.js.org/docs) for easy reference and testing. If you would like to help us with this, we would be very grateful!
45-
46-
Our Storybook site is hosted [docs.waveterm.dev/storybook](https://docs.waveterm.dev/storybook).
47-
4842
### Create a Pull Request
4943

5044
Guidelines:
@@ -62,8 +56,6 @@ The project is broken into four main components: frontend, emain, wavesrv, and w
6256

6357
Our frontend can be found in the [`/frontend`](./frontend/) directory. It is written in React Typescript. The main entrypoint is [`wave.ts`](./frontend/wave.ts) and the root for the React VDOM is [`app.tsx`](./frontend/app/app.tsx). If you are using `task dev` to run your dev instance of the app, the frontend will be loaded using Vite, which allows for Hot Module Reloading. This should work for most styling and simple component changes, but anything that affects the state of the app (the Jotai or layout code, for instance) may put the frontend into a bad state. If this happens, you can force reload the frontend using `Cmd:Shift:R` or `Ctrl:Shift:R`.
6458

65-
We also have a Storybook project configured for testing our component library. We're still working to fill out the test cases for this, but it is useful for testing components in isolation. You can run this using `task storybook`.
66-
6759
### emain
6860

6961
emain can be found at [`/emain`](./emain/). It is the main NodeJS process and is first thing that is run when you start up the app and it forks off the process for the wavesrv backend and manages all the Electron interfaces, such as window and view management, context menus, and native UI calls. Its main entrypoint is [`emain.ts`](./emain/emain.ts). This process does not hot-reload, you will need to manually kill the dev instance and rerun it to apply changes.

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,6 @@ Find more information in our [Contributions Guide](CONTRIBUTING.md), which inclu
8080

8181
- [Ways to contribute](CONTRIBUTING.md#contributing-to-wave-terminal)
8282
- [Contribution guidelines](CONTRIBUTING.md#before-you-start)
83-
- [Storybook](https://docs.waveterm.dev/storybook)
8483

8584
## License
8685

Taskfile.yml

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -54,20 +54,6 @@ tasks:
5454
WCLOUD_ENDPOINT: "https://api-dev.waveterm.dev/central"
5555
WCLOUD_WS_ENDPOINT: "wss://wsapi-dev.waveterm.dev/"
5656

57-
storybook:
58-
desc: Start the Storybook server.
59-
cmd: npm run storybook
60-
deps:
61-
- npm:install
62-
63-
storybook:build:
64-
desc: Build the Storybook static site.
65-
cmd: npm run build-storybook
66-
generates:
67-
- storybook-static/**/*
68-
deps:
69-
- npm:install
70-
7157
docs:npm:install:
7258
desc: Runs `npm install` in docs directory
7359
internal: true
@@ -93,20 +79,17 @@ tasks:
9379
desc: Build the full docsite.
9480
cmds:
9581
- cd docs && npm run build
96-
- task: copyfiles:'storybook-static':'docs/build/storybook'
9782
env:
9883
USE_SIMPLE_CSS_MINIFIER: "true"
9984
sources:
10085
- "docs/*"
10186
- "docs/src/**/*"
10287
- "docs/docs/**/*"
10388
- "docs/static/**/*"
104-
- storybook-static/**/*
10589
generates:
10690
- "docs/build/**/*"
10791
deps:
10892
- docs:npm:install
109-
- storybook:build
11093

11194
package:
11295
desc: Package the application for the current platform.

docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ This command starts a local development server and opens up a browser window. Mo
1717
### Build
1818

1919
```sh
20-
task docsite:build:<embedded,public>
20+
task docsite:build:public
2121
```
2222

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

2525
### Deployment
2626

27-
Deployments are handled automatically by the [Docsite and Storybook CI/CD workflow](../.github/workflows/deploy-docsite.yml)
27+
Deployments are handled automatically by the [Docsite CI/CD workflow](../.github/workflows/deploy-docsite.yml)

0 commit comments

Comments
 (0)