-
Notifications
You must be signed in to change notification settings - Fork 0
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?
docs: refresh repository and module READMEs #2
Conversation
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.
Pull request overview
This PR refreshes repository and module-level documentation to better orient contributors and users. The changes clarify which components live in this repository versus separate repos, and provide quick-start commands for local development of docs, apps, and daemons.
Changes:
- Added module-level READMEs for
website/,travel/, anddocs/directories - Updated
app/README.mdwith tech stack, project layout, and development commands - Reorganized root
README.mdto highlight repository contents and add quick-start sections for each module - Updated
benchmarks/README.mdto document chart generation tools and dependencies
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| website/README.md | New README documenting the React + Vite marketing site with dev/build commands |
| travel/README.md | New README for fgp-travel daemon documenting methods, usage, and build instructions |
| docs/README.md | New README for MkDocs documentation site with local dev workflow |
| benchmarks/README.md | Added generate_charts.py to table and plotly/kaleido to requirements |
| app/README.md | Expanded with tech stack, project layout, and comprehensive command reference |
| README.md | Reorganized to clarify repo contents and provide module-specific quick-start paths |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # 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. |
Copilot
AI
Jan 15, 2026
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."
| 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. | |
| 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**. |
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.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 73568e520e
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| cd docs | ||
| python3 -m venv .venv | ||
| source .venv/bin/activate | ||
| pip install -r requirements.txt | ||
| mkdocs serve |
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.
Run MkDocs from repo root or pass config path
Following these steps from docs/ will make mkdocs serve/mkdocs build fail because the MkDocs config file lives in the repo root (/workspace/fgp/mkdocs.yml) rather than in docs/. Anyone running the commands as written will hit a “config file not found” error unless they run MkDocs from the repo root or pass -f ../mkdocs.yml, so local docs dev/build is broken as documented.
Useful? React with 👍 / 👎.
Motivation
app,travel,website, anddocsso each area of the workspace is self-describing for new developers.Description
README.mdto list what actually lives in the repo, add quick paths fordocs,app,website,travel, andbenchmarks, and align the Quick Start sections to repository-local commands (e.g.cd docs,cd app,cd travel).app/README.mdwith tech stack, project layout, development and build commands (pnpm install,pnpm dev,pnpm tauri build).docs/README.mdandwebsite/README.mddescribing MkDocs local dev (mkdocs serve) and website dev/build (pnpm dev/pnpm build).travel/README.mddocumenting thefgp-traveldaemon methods, usage, socket path, and build/run commands, and updatedbenchmarks/README.mdto document chart generation tools and add plotly/kaleido to requirements.Testing
README.md,app/README.md,docs/README.md,travel/README.md,benchmarks/README.md,website/README.md).Codex Task