Skip to content

Commit ea7e5b8

Browse files
committed
Add Getting Started guide and Gallery with screenshots
- Add Getting Started page with Docker and native dev setup instructions - Add Gallery page showcasing Forge UI and Armory components - Include 10 screenshots demonstrating all UI features - Update home page with Get Started and Gallery buttons - Reorganize sidebar with Getting Started section - Add CSS styling for screenshot presentation - Change status from "experimental" to "early access"
1 parent 8f16193 commit ea7e5b8

15 files changed

Lines changed: 421 additions & 6 deletions

.vitepress/config.ts

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,25 @@ export default defineConfig({
2828

2929
nav: [
3030
{ text: 'Home', link: '/' },
31+
{ text: 'Get Started', link: '/docs/getting-started' },
32+
{ text: 'Gallery', link: '/docs/gallery' },
3133
{ text: 'Docs', link: '/docs/' },
3234
{ text: 'GitHub', link: 'https://github.com/agentic-forge' }
3335
],
3436

3537
sidebar: {
3638
'/docs/': [
3739
{
38-
text: 'Documentation',
40+
text: 'Getting Started',
3941
items: [
40-
{ text: 'Architecture', link: '/docs/' },
42+
{ text: 'Quick Start', link: '/docs/getting-started' },
43+
{ text: 'Gallery', link: '/docs/gallery' },
44+
]
45+
},
46+
{
47+
text: 'Architecture',
48+
items: [
49+
{ text: 'Overview', link: '/docs/' },
4150
{ text: 'Orchestrator', link: '/docs/orchestrator' },
4251
{ text: 'Armory', link: '/docs/armory' },
4352
{ text: 'Anvil', link: '/docs/anvil' },

.vitepress/theme/custom.css

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,3 +122,29 @@ th {
122122
.VPNavBarTitle .title {
123123
font-weight: 700;
124124
}
125+
126+
/* Screenshot/Gallery image styling */
127+
.vp-doc img {
128+
border-radius: 8px;
129+
border: 1px solid var(--vp-c-border);
130+
box-shadow: 0 4px 12px rgba(0, 0, 0, 0.15);
131+
margin: 16px 0;
132+
max-width: 100%;
133+
height: auto;
134+
}
135+
136+
.dark .vp-doc img {
137+
box-shadow: 0 4px 12px rgba(0, 0, 0, 0.4);
138+
}
139+
140+
/* Gallery page specific styles */
141+
.vp-doc h3 + p + p > img,
142+
.vp-doc h3 + p > img {
143+
margin-top: 8px;
144+
}
145+
146+
/* Horizontal rule styling for section breaks */
147+
.vp-doc hr {
148+
margin: 48px 0;
149+
border-color: var(--vp-c-border);
150+
}

docs/gallery.md

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Gallery
2+
3+
A visual tour of Agentic Forge's components and features.
4+
5+
## Forge UI - Chat Interface
6+
7+
The main user interface for interacting with AI agents. Built with Vue.js and PrimeVue.
8+
9+
### Welcome Screen
10+
11+
Clean landing page with options to start a new conversation or import an existing one.
12+
13+
![Forge UI Welcome](/screens/forge-ui-landing.png)
14+
15+
### Chat with Tool Calls
16+
17+
Watch the AI use tools in real-time. Expandable tool call panels show arguments and results.
18+
19+
![Chat with Tool Call](/screens/forge-ui-tc-detail.png)
20+
21+
### Extended Thinking
22+
23+
Models with reasoning capabilities (like DeepSeek R1) show their thinking process.
24+
25+
![Extended Thinking](/screens/forge-ui.png)
26+
27+
### Multi-Model Support
28+
29+
Switch between 100+ models from OpenRouter. See pricing and capabilities at a glance.
30+
31+
![Model Selection](/screens/forge-ui-model-selection.png)
32+
33+
### Parallel Tool Calls
34+
35+
Advanced queries trigger multiple tool calls simultaneously. The UI tracks each one.
36+
37+
![Multi Tool Call](/screens/forge-ui-multi-tool-call.png)
38+
39+
---
40+
41+
## Forge Armory - MCP Gateway
42+
43+
The protocol gateway that aggregates MCP servers and exposes them through a unified interface.
44+
45+
### Dashboard Overview
46+
47+
At-a-glance metrics: connected backends, available tools, call statistics, and latency.
48+
49+
![Armory Dashboard](/screens/forge-armory-dashboard.png)
50+
51+
### Backend Management
52+
53+
Add, configure, enable/disable MCP server backends. Each backend contributes tools to the unified registry.
54+
55+
![Armory Backends](/screens/forge-armory-backends.png)
56+
57+
### Tool Registry
58+
59+
Browse all available tools across backends. Search by name, filter by backend, view schemas.
60+
61+
![Armory Tools](/screens/forge-armory-tools.png)
62+
63+
### Metrics & Observability
64+
65+
Track tool call history, latency, success rates. Filter by time range, tool, or backend.
66+
67+
![Armory Metrics](/screens/forge-armory-metrics.png)
68+
69+
---
70+
71+
## Development Environment
72+
73+
### tmux-based Development
74+
75+
Native development with hot reload. All services running in organized tmux panes.
76+
77+
![Development Services](/screens/forge-services.png)
78+
79+
The `dev-start.sh` script launches:
80+
- **forge-ui** - Frontend with Vite hot reload
81+
- **forge-orchestrator** - Python backend with auto-restart
82+
- **forge-armory** - Gateway with live config
83+
- **MCP servers** - Weather and web search
84+
85+
---
86+
87+
## Architecture
88+
89+
```
90+
┌─────────────────────────────────────────────────────────────┐
91+
│ FORGE UI │
92+
│ (localhost:4040) │
93+
│ Vue.js chat interface with model selection │
94+
└─────────────────────────────┬───────────────────────────────┘
95+
│ WebSocket/SSE
96+
97+
┌─────────────────────────────────────────────────────────────┐
98+
│ ORCHESTRATOR │
99+
│ (localhost:4041) │
100+
│ LLM conversation loop with tool routing │
101+
└─────────────────────────────┬───────────────────────────────┘
102+
│ MCP Protocol
103+
104+
┌─────────────────────────────────────────────────────────────┐
105+
│ ARMORY │
106+
│ (localhost:4042) │
107+
│ Protocol gateway aggregating MCP backends │
108+
└───────────┬─────────────────┴─────────────────┬─────────────┘
109+
│ │
110+
▼ ▼
111+
┌───────────────────────┐ ┌───────────────────────────┐
112+
│ MCP Weather │ │ MCP Web Search │
113+
│ (localhost:4050) │ │ (localhost:4051) │
114+
│ Open-Meteo API │ │ Brave Search API │
115+
└───────────────────────┘ └───────────────────────────┘
116+
```
117+
118+
## Design System
119+
120+
All Forge UI components use **PrimeVue 4** with the **Aura theme** and violet primary color.
121+
122+
| Element | Usage |
123+
|---------|-------|
124+
| **Primary (Violet)** | Interactive elements, buttons, links |
125+
| **Green** | Connected, enabled, success states |
126+
| **Red** | Errors, delete actions |
127+
| **Orange** | Tool calls in progress |
128+
| **Dark background** | Default theme (`#0f0f14`) |
129+
130+
---
131+
132+
Ready to try it yourself? Head to the [Getting Started](/docs/getting-started) guide!

0 commit comments

Comments
 (0)