Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 3 additions & 6 deletions .github/workflows/deploy-docsite.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: Docsite and Storybook CI/CD
name: Docsite CI/CD

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

env:
NODE_VERSION: 22
Expand All @@ -10,7 +10,7 @@ on:
branches:
- main
workflow_dispatch:
# Also run any time a PR is opened targeting the docs or storybook resources
# Also run any time a PR is opened targeting the docs
pull_request:
branches:
- main
Expand All @@ -21,9 +21,6 @@ on:
- ready_for_review
paths:
- "docs/**"
- "storybook/**"
- "**/*.story.*"
- "**/*.stories.*"
- ".github/workflows/deploy-docsite.yml"
- "Taskfile.yml"

Expand Down
18 changes: 0 additions & 18 deletions .storybook/custom-addons/theme/register.ts

This file was deleted.

20 changes: 0 additions & 20 deletions .storybook/global.css

This file was deleted.

83 changes: 0 additions & 83 deletions .storybook/main.ts

This file was deleted.

60 changes: 0 additions & 60 deletions .storybook/preview.tsx

This file was deleted.

17 changes: 0 additions & 17 deletions .storybook/theme.ts

This file was deleted.

8 changes: 0 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,6 @@ We have a set of recommended Visual Studio Code extensions to enforce our style

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

### UI Component Library

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!

Our Storybook site is hosted [docs.waveterm.dev/storybook](https://docs.waveterm.dev/storybook).

### Create a Pull Request

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

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`.

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`.

### emain

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.
Expand Down
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,6 @@ Find more information in our [Contributions Guide](CONTRIBUTING.md), which inclu

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

## License

Expand Down
17 changes: 0 additions & 17 deletions Taskfile.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,20 +54,6 @@ tasks:
WCLOUD_ENDPOINT: "https://api-dev.waveterm.dev/central"
WCLOUD_WS_ENDPOINT: "wss://wsapi-dev.waveterm.dev/"

storybook:
desc: Start the Storybook server.
cmd: npm run storybook
deps:
- npm:install

storybook:build:
desc: Build the Storybook static site.
cmd: npm run build-storybook
generates:
- storybook-static/**/*
deps:
- npm:install

docs:npm:install:
desc: Runs `npm install` in docs directory
internal: true
Expand All @@ -93,20 +79,17 @@ tasks:
desc: Build the full docsite.
cmds:
- cd docs && npm run build
- task: copyfiles:'storybook-static':'docs/build/storybook'
env:
USE_SIMPLE_CSS_MINIFIER: "true"
sources:
- "docs/*"
- "docs/src/**/*"
- "docs/docs/**/*"
- "docs/static/**/*"
- storybook-static/**/*
generates:
- "docs/build/**/*"
deps:
- docs:npm:install
- storybook:build

package:
desc: Package the application for the current platform.
Expand Down
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ This command starts a local development server and opens up a browser window. Mo
### Build

```sh
task docsite:build:<embedded,public>
task docsite:build:public
```

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

### Deployment

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