-
Notifications
You must be signed in to change notification settings - Fork 1
docs: refresh repository and module READMEs #2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,45 @@ | ||
| # Tauri + SvelteKit + TypeScript | ||
| # FGP Manager App | ||
|
|
||
| This template should help get you started developing with Tauri, SvelteKit and TypeScript in Vite. | ||
| Desktop companion app for managing local FGP daemons. Built with **Tauri**, **SvelteKit**, and **TypeScript** and designed as a small popover window that can start/stop daemons, show status, and open the marketplace view. | ||
|
|
||
| ## Recommended IDE Setup | ||
| ## Tech stack | ||
|
|
||
| [VS Code](https://code.visualstudio.com/) + [Svelte](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer). | ||
| - Tauri 2 (Rust backend + webview) | ||
| - SvelteKit + TypeScript (frontend) | ||
| - Tailwind CSS for styling | ||
|
|
||
| ## Project layout | ||
|
|
||
| ``` | ||
| app/ | ||
| ├── src/ # Svelte routes + UI | ||
| ├── src-tauri/ # Tauri Rust commands & config | ||
| ├── static/ # Static assets | ||
| └── vite.config.js # Vite configuration | ||
| ``` | ||
|
|
||
| ## Development | ||
|
|
||
| ```bash | ||
| pnpm install | ||
| pnpm dev | ||
| ``` | ||
|
|
||
| ## Building | ||
|
|
||
| ```bash | ||
| pnpm install | ||
| pnpm build | ||
| pnpm tauri build | ||
| ``` | ||
|
|
||
| ## Useful commands | ||
|
|
||
| - `pnpm dev` - Run the SvelteKit dev server | ||
| - `pnpm tauri dev` - Run the Tauri desktop shell in dev mode | ||
| - `pnpm tauri build` - Produce a production desktop build | ||
|
|
||
| ## Notes | ||
|
|
||
| - The frontend relies on Tauri commands like `list_daemons`, `start_daemon`, and `stop_daemon` from the Rust backend in `src-tauri/`. | ||
| - Marketplace is rendered in a separate Tauri window opened from the main popover UI. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| # Documentation Site | ||
|
|
||
| This directory contains the MkDocs source for the Fast Gateway Protocol documentation at https://fast-gateway-protocol.github.io/fgp/. | ||
|
|
||
| ## Structure | ||
|
|
||
| - `index.md` - Landing page | ||
| - `getting-started/` - Installation and quickstart guides | ||
| - `daemons/` - Service-specific docs | ||
| - `protocol/` - NDJSON protocol spec | ||
| - `reference/` - CLI + API reference | ||
| - `development/` - Contributor and build docs | ||
| - `assets/` - Images and charts used in docs | ||
|
|
||
| ## Local development | ||
|
|
||
| ```bash | ||
| cd docs | ||
| python3 -m venv .venv | ||
| source .venv/bin/activate | ||
| pip install -r requirements.txt | ||
| mkdocs serve | ||
|
Comment on lines
+18
to
+22
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Following these steps from Useful? React with 👍 / 👎. |
||
| ``` | ||
|
|
||
| ## Build | ||
|
|
||
| ```bash | ||
| mkdocs build | ||
| ``` | ||
|
|
||
| ## Updating benchmarks | ||
|
|
||
| Benchmark charts are generated from `benchmarks/generate_charts.py` in the repo root and written to `docs/assets/`. | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The sentence structure is awkward with two consecutive "and" phrases. Consider revising to: "Desktop companion app for managing local FGP daemons, designed as a small popover window that can start/stop daemons, show status, and open the marketplace view. Built with Tauri, SvelteKit, and TypeScript."