waveterm/docs/README.md

<p align="center">
  <picture>
	<source media="(prefers-color-scheme: dark)" srcset="../assets/wave-dark.png">
	<source media="(prefers-color-scheme: light)" srcset="../assets/wave-light.png">
	<img alt="Wave Terminal Logo" src="../assets/wave-light.png" width="240">
  </picture>
  <br/>
</p>

# Wave Terminal Documentation

This is the home for Wave Terminal's documentation site. This README is specifically about _building_ and contributing to the docs site. If you are looking for the actual hosted docs, go here -- https://docs.waveterm.dev

### Installation

Our docs are built using [Docusaurus](https://docusaurus.io/), a modern static website generator.

```sh
yarn
```

### Local Development

```sh
yarn start
```

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

### Build

```sh
yarn build
```

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 [Deploy action](.github/workflows/deploy.yml)
Move docsite to main repo (#1204) ## Summary We are moving our docsite to this repo for better coordination. ## What's changed? - The docsite codebase is now in docs/ - The docsite will replace storybook as the published GitHub Pages site for this repo - Storybook will now be hosted at https://docs.waveterm.dev/storybook - A new CI workflow will validate any changes to Storybook or the docsite - A combined CD workflow will build and deploy Storybook and the docsite as a single artifact - The Build Helper workflow will now build an embedded version of the docsite before building the app, ensuring the docsite version it has is always the latest 2024-11-06 19:45:21 +01:00			`<p align="center">`
			`<picture>`
Fix wave logo for docs readme (#1222) 2024-11-06 21:30:44 +01:00			`<source media="(prefers-color-scheme: dark)" srcset="../assets/wave-dark.png">`
			`<source media="(prefers-color-scheme: light)" srcset="../assets/wave-light.png">`
			`<img alt="Wave Terminal Logo" src="../assets/wave-light.png" width="240">`
Move docsite to main repo (#1204) ## Summary We are moving our docsite to this repo for better coordination. ## What's changed? - The docsite codebase is now in docs/ - The docsite will replace storybook as the published GitHub Pages site for this repo - Storybook will now be hosted at https://docs.waveterm.dev/storybook - A new CI workflow will validate any changes to Storybook or the docsite - A combined CD workflow will build and deploy Storybook and the docsite as a single artifact - The Build Helper workflow will now build an embedded version of the docsite before building the app, ensuring the docsite version it has is always the latest 2024-11-06 19:45:21 +01:00			`</picture>`
			`<br/>`
			`</p>`

			`# Wave Terminal Documentation`

			`This is the home for Wave Terminal's documentation site. This README is specifically about _building_ and contributing to the docs site. If you are looking for the actual hosted docs, go here -- https://docs.waveterm.dev`

			`### Installation`

			`Our docs are built using [Docusaurus](https://docusaurus.io/), a modern static website generator.`

			```sh
			`yarn`
			```

			`### Local Development`

			```sh
			`yarn start`
			```

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

			`### Build`

			```sh
			`yarn build`
			```

			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 [Deploy action](.github/workflows/deploy.yml)`