Skip to content

Commit 8912f75

Browse files
docs(gui): add comprehensive Sphinx documentation for GUI
- Add getting-started guide with installation, launching, and features - Add API backend developer docs (routes, services, database) - Add frontend developer docs (components, pages, api-client) - Add screenshots for all GUI pages - Update homepage with GUI section and navigation - Link existing GUI design docs to toctree - Fix syntax highlighting warnings in design docs Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 397cdd9 commit 8912f75

31 files changed

Lines changed: 3254 additions & 11 deletions

docs/_static/images/gui/README.txt

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# GUI Screenshots
2+
3+
This directory contains screenshots for the GUI documentation.
4+
5+
## Required Screenshots
6+
7+
Capture these screenshots from the running GUI at http://127.0.0.1:8765:
8+
9+
| Filename | Page | What to Capture |
10+
|----------|------|-----------------|
11+
| `run-list-page.png` | RunListPage (`/`) | Multiple run cards with varied statuses (pending, running, completed, failed) |
12+
| `new-run-page.png` | NewRunPage (`/runs/new`) | Form with template dropdown expanded |
13+
| `run-detail-logs.png` | RunDetailPage | Logs tab showing log content |
14+
| `run-detail-artifacts.png` | RunDetailPage | Artifacts tab showing file browser |
15+
| `topology-page.png` | TopologyPage (`/topology`) | Network graph with a node selected |
16+
| `config-editor.png` | ConfigEditorPage (`/config`) | Editor showing INI content |
17+
| `codebase-architecture.png` | CodebaseExplorerPage (`/codebase`) | Architecture view with module cards |
18+
| `codebase-code.png` | CodebaseExplorerPage | Code view with file tree and code panel |
19+
| `settings-page.png` | SettingsPage (`/settings`) | Theme selection options |
20+
21+
## Guidelines
22+
23+
- Use a consistent browser window size (1280x800 recommended)
24+
- Capture only the content area, not browser chrome
25+
- Use light theme for consistent documentation appearance
26+
- Ensure no sensitive or personal data is visible
27+
- Save as PNG format
28+
29+
## After Capturing
30+
31+
Once screenshots are added, update the `[Screenshot: ...]` placeholders in
32+
`docs/getting-started/gui/features.rst` with actual image directives:
33+
34+
```rst
35+
.. image:: /_static/images/gui/run-list-page.png
36+
:alt: Run list page showing simulation runs
37+
:width: 100%
38+
```
266 KB
Loading
255 KB
Loading
259 KB
Loading
174 KB
Loading
112 KB
Loading
237 KB
Loading
90.9 KB
Loading
97.1 KB
Loading
245 KB
Loading

0 commit comments

Comments
 (0)