Skip to content

Commit 491cdc7

Browse files
authored
fix: readme in dashboard app (#1868)
1 parent 49f386e commit 491cdc7

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

crates/fig_desktop/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Fig Desktop
1+
# Amazon Q Desktop
22

3-
This is the main Fig app written in Rust. It should be
3+
This is the main Amazon Q Desktop written in Rust. It should be
44
ready to run and start developing with if you follow the
55
instructions in the [root README](../README.md).
66

@@ -10,4 +10,4 @@ instructions in the [root README](../README.md).
1010
1. Run `cargo run`.
1111
1. Once the UI opens, right click anywhere to inspect element, go to the console tab, and set `window.location.href`
1212
to the URL of the dashboard development server.
13-
13+
- Alternatively, you can use the `DASHBOARD_URL` environment variable instead of manually setting `window.location.href`, e,g. `DASHBOARD_URL=http://localhost:3433 cargo run`.

packages/dashboard-app/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,12 @@
22

33
This folder holds the React single-page app for the Amazon Q desktop UI.
44

5+
<div align="center">
6+
<img width="600" alt="Dashboard UI" src="https://github.com/user-attachments/assets/aaebc6ed-2048-41f9-a619-dabaedc55415" />
7+
</div>
8+
59
## Developing
610

7-
1. Run the `build-ts.sh` script under the `proto/` folder in the project root to ensure typescript definitions are generated.
811
1. Run `pnpm build` in the project root.
912
1. Run `npm run dev`.
13+
1. Start the main Amazon Q Desktop according to the instructions in the [Amazon Q Desktop README](../../crates/fig_desktop/README.md).

0 commit comments

Comments
 (0)