From 6aaa62acddda3b6744edcaf0c08ca451b4e482e6 Mon Sep 17 00:00:00 2001 From: Evan Simkowitz Date: Wed, 6 Nov 2024 12:24:53 -0800 Subject: [PATCH] Update edit url and remove waveterm-docs refs and fix fontawesome (#1221) --- .storybook/main.ts | 32 +++++++++++++++++++++++++++++++- .storybook/preview-head.html | 25 ------------------------- CONTRIBUTING.md | 2 +- docs/docs/index.mdx | 33 ++++++++++++++++----------------- docs/docusaurus.config.ts | 2 +- 5 files changed, 49 insertions(+), 45 deletions(-) delete mode 100644 .storybook/preview-head.html diff --git a/.storybook/main.ts b/.storybook/main.ts index ca1080277..a9e6251d1 100644 --- a/.storybook/main.ts +++ b/.storybook/main.ts @@ -37,7 +37,10 @@ const config: StorybookConfig = { return mergedConfig; }, - staticDirs: [{ from: "../assets", to: "/assets" }], + staticDirs: [ + { from: "../assets", to: "/assets" }, + { from: "../public/fontawesome", to: "/fontawesome" }, + ], managerHead: (head) => ` ${head} @@ -48,5 +51,32 @@ const config: StorybookConfig = { max-height: 100px !important; } `, + previewHead: (head) => ` + ${head} + + + + + + `, }; export default config; diff --git a/.storybook/preview-head.html b/.storybook/preview-head.html deleted file mode 100644 index 28bf535fa..000000000 --- a/.storybook/preview-head.html +++ /dev/null @@ -1,25 +0,0 @@ - - - - - - diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 110ecfc66..66038eae2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,7 +43,7 @@ To build and run Wave locally, see instructions at [Building Wave Terminal](./BU 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 [storybook.waveterm.dev](https://storybook.waveterm.dev). +Our Storybook site is hosted [docs.waveterm.dev/storybook](https://docs.waveterm.dev/storybook). ### Create a Pull Request diff --git a/docs/docs/index.mdx b/docs/docs/index.mdx index 052cfeb54..02d49a3e6 100644 --- a/docs/docs/index.mdx +++ b/docs/docs/index.mdx @@ -6,25 +6,25 @@ hide_title: true hide_table_of_contents: true --- -import {Card, CardGroup} from '@site/src/components/card.tsx'; +import { Card, CardGroup } from "@site/src/components/card.tsx"; # Welcome to Wave Terminal -Wave is an [open-source](https://github.com/wavetermdev/waveterm) terminal that adds the ability to launch graphical widgets, controlled and integrated directly with the CLI. We support MacOS, Linux, and Windows ([Downloads](https://waveterm.dev/download)). +Wave is an [open-source](https://github.com/wavetermdev/waveterm) terminal that adds the ability to launch graphical widgets, controlled and integrated directly with the CLI. We support MacOS, Linux, and Windows ([Downloads](https://waveterm.dev/download)). -**These docs are incomplete**, but we're working on them. If you have a question, please feel free to ask us in [Discord](https://discord.gg/XfvZ334gwU). If you'd like to file a bug/enchancement, please -use [Github Issues](https://github.com/wavetermdev/waveterm/issues). These docs are also open-source and we do accept PRs in our [docs repo](https://github.com/wavetermdev/waveterm-docs) +**These docs are incomplete**, but we're working on them. If you have a question, please feel free to ask us in [Discord](https://discord.gg/XfvZ334gwU). If you'd like to file a bug/enchancement, please +use [Github Issues](https://github.com/wavetermdev/waveterm/issues). These docs are also open-source and we do accept PRs for docs [here](https://github.com/wavetermdev/waveterm/blob/main/docs). You can click the "Edit this page" link at the bottom of the page to get taken directly to the editor page for that document in GitHub. References: -* [Widgets](./widgets) -* [Configuration](./config) -* [Key Bindings](./keybindings) -* [wsh command](./wsh) -* [Connections](./connections) -* [Custom Widgets](./customwidgets) -* [Telemetry](./telemetry) -* [FAQ](./faq) +- [Widgets](./widgets) +- [Configuration](./config) +- [Key Bindings](./keybindings) +- [wsh command](./wsh) +- [Connections](./connections) +- [Custom Widgets](./customwidgets) +- [Telemetry](./telemetry) +- [FAQ](./faq)