mirror of
https://github.com/wavetermdev/waveterm
synced 2026-05-24 09:18:27 +00:00
a23bbc00dc
Removes the embedded Docusaurus build from the application. The help view now always loads from https://docs.waveterm.dev/ instead of serving a locally bundled copy. This eliminates package size constraints on documentation content (e.g., videos) and removes unnecessary build/packaging overhead. **Backend changes:** - Deleted `pkg/docsite` package entirely - Removed docsite handler from `pkg/web/web.go` - Simplified `emain/docsite.ts` to return constant URL instead of probing for embedded docs **Frontend changes:** - Removed embedded URL translation logic from `helpview.tsx` - Homepage URL now uses constant instead of IPC call **Build configuration:** - Removed `docsite:build:embedded` task and all references - Removed `dist/docsite/**/*` from electron-builder asarUnpack - Removed `build-embedded` script from docs package.json Net result: -141 lines, +9 lines across 8 files. <!-- START COPILOT CODING AGENT SUFFIX --> <details> <summary>Original prompt</summary> > right now we build a docusaurus project to run both the online docs at docs.waveterm.dev AND to embed into the application. but this limits what we can show in the docs (especially large things like videos etc.) > > the internal docs already fall back to the website when it cannot find the embedded docs. > > i'd like to update the build and packaging etc to no longer build the embedded doc site. i'd also like to have the "help" view always render the live doc site at https://docs.waveterm.dev. </details> <!-- START COPILOT CODING AGENT TIPS --> --- 💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more [Copilot coding agent tips](https://gh.io/copilot-coding-agent-tips) in the docs. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: sawka <2722291+sawka@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| docs | ||
| src | ||
| static | ||
| .editorconfig | ||
| .gitignore | ||
| .prettierignore | ||
| .remarkrc | ||
| 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.
Local Development
task docsite
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
task docsite:build:<embedded,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