mirror of
https://github.com/wavetermdev/waveterm.git
synced 2024-12-21 16:38:23 +01:00
0925af5300
Adds warning and docs to let users know when they're running in ARM translation mode. Also lets them configure to always dismiss if they don't care. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Added a configuration option to dismiss architecture warnings during application startup. - Introduced new FAQs addressing ARM64 translation warnings and instructions for joining beta builds. - Added platform-specific requirements for macOS, Windows, and Linux in the getting started documentation. - **Bug Fixes** - Enhanced build command flexibility by allowing dynamic command-line arguments during the build process. - **Documentation** - Updated configuration documentation to include the new dismiss architecture warning key. - Minor formatting adjustments in FAQs and getting started documentation. - Clarified platform compatibility details in the README. - **Chores** - Added a new constant for the dismiss architecture warning configuration key. - Introduced a new field for managing architecture warning settings in the application configuration. <!-- end of auto-generated comment: release notes by coderabbit.ai --> |
||
|---|---|---|
| .. | ||
| docs | ||
| src | ||
| static | ||
| .editorconfig | ||
| .gitignore | ||
| .prettierignore | ||
| .remarkrc | ||
| .yarnrc.yml | ||
| babel.config.js | ||
| docusaurus.config.ts | ||
| eslint.config.js | ||
| package.json | ||
| prettier.config.cjs | ||
| README.md | ||
| tsconfig.json | ||
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, a modern static website generator.
yarn
Local Development
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
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 Docsite and Storybook CI/CD workflow