Skip to content

Commit f296da7

Browse files
committed
update docs
1 parent 584edf7 commit f296da7

File tree

6 files changed

+13
-27
lines changed

6 files changed

+13
-27
lines changed

docs/docs/installation.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@ Before you begin, ensure you have:
1313
- **Docker & Docker Compose** (recommended) - Version 20.10+
1414
- **OR** for manual installation:
1515
- Go 1.21 or higher
16-
- PostgreSQL/TimescaleDB 16+
17-
- Node.js 20+ (for web dashboard)
16+
- TimescaleDB 16+
1817

1918
## Docker Image (Recommended)
2019

@@ -55,6 +54,9 @@ services:
5554

5655
mcpulse:
5756
image: ghcr.io/sirrobot01/mcpulse:latest # or cy01/mcpulse:latest
57+
container_name: mcpulse-server
58+
volumes:
59+
- ./config.yaml:/app/config.yaml
5860
ports:
5961
- "8080:8080" # Web UI and API
6062
- "9090:9090" # gRPC endpoint
@@ -97,13 +99,11 @@ mcpulse-server "/app/mcpulse" Up
9799
mcpulse-timescale "docker-entrypoint..." Up
98100
```
99101

100-
Visit http://localhost:8080 to see the MCPulse dashboard.
101-
102102
### Step 5: Create an API Key
103103

104104
1. Visit http://localhost:8080
105105
2. Create an account or log in
106-
3. Go to **Settings** → **API Keys**
106+
3. Go to **API Keys**
107107
4. Click **Create API Key**
108108
5. Copy the generated key (you'll need it for SDK integration)
109109

docs/docs/intro.md

Lines changed: 5 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
sidebar_position: 1
3-
slug: /
43
---
54

65
# Introduction
@@ -18,20 +17,11 @@ Get answers to critical questions about your MCP servers:
1817

1918
## Key Features
2019

21-
**Universal Compatibility**
22-
Works with MCP servers in any language - Python, Go, TypeScript, Rust, and more.
23-
24-
**Real-time Analytics**
25-
Monitor tool calls, sessions, errors, and performance as they happen.
26-
27-
**Time-Series Storage**
28-
Built on TimescaleDB for efficient storage with automatic compression and retention.
29-
30-
**Privacy-First**
31-
Self-hosted with automatic parameter sanitization. Your data stays on your infrastructure.
32-
33-
**High Performance**
34-
Built in Go - handles 10,000+ events/second with sub-second query latency.
20+
- **Universal Compatibility**: Works with MCP servers in any language - Python, Go, TypeScript, Rust, and more.
21+
- **Real-time Analytics**: Monitor tool calls, sessions, errors, and performance as they happen.
22+
- **Time-Series Storage**: Built on TimescaleDB for efficient storage with automatic compression and retention.
23+
- **Privacy-First**: Self-hosted with automatic parameter sanitization. Your data stays on your infrastructure.
24+
- **High Performance**: Built in Go - handles 10,000+ events/second with sub-second query latency.
3525

3626
## Quick Start
3727

@@ -42,9 +32,6 @@ Built in Go - handles 10,000+ events/second with sub-second query latency.
4232
curl -O https://raw.githubusercontent.com/sirrobot01/mcpulse/main/docker-compose.yml
4333
curl -o config.yaml https://raw.githubusercontent.com/sirrobot01/mcpulse/main/config.yaml.example
4434

45-
46-
Start the services:
47-
```bash
4835
docker compose up -d
4936
```
5037

docs/docs/sdks/go.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,6 @@ config := mcpulse.Config{
6868

6969
// Endpoints
7070
GRPCEndpoint: "localhost:9090",
71-
RESTEndpoint: "http://localhost:8080",
7271

7372
// Authentication
7473
APIKey: "your-api-key",

docs/docusaurus.config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ const config: Config = {
4949
items: [
5050
{
5151
type: 'doc',
52-
docId: 'installation',
52+
docId: 'intro',
5353
position: 'left',
5454
label: 'Get Started',
5555
},

docs/src/pages/index.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ function HomepageHeader() {
4646
<div className={styles.heroButtons}>
4747
<Link
4848
className={clsx('button', styles.primaryButton)}
49-
to="/installation">
49+
to="/intro">
5050
Get Started
5151
</Link>
5252
<Link
@@ -59,7 +59,7 @@ function HomepageHeader() {
5959
<div className={styles.heroVisual}>
6060
<div className={styles.dashboardPreview}>
6161
<img
62-
src={colorMode === 'dark' ? '/img/mcpulse-dark.png' : '/img/mcpulse-light.png'}
62+
src={colorMode === 'light' ? '/img/mcpulse-light.png': '/img/mcpulse-dark.png'}
6363
alt="MCPulse Dashboard Screenshot"
6464
className={styles.dashboardImage}
6565
/>

docs/static/img/favicon.ico

15 KB
Binary file not shown.

0 commit comments

Comments
 (0)