Skip to content

feat: add help page for Claude Code client setup #118

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.

Sign up for GitHub

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

Open
crystalin wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add help page for Claude Code client setup #118

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/02-User-Guide/dashboard-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,17 @@ View per-account statistics:

## Navigation

### Dashboard Pages

The dashboard includes the following pages accessible from the navigation bar:

- **Dashboard** - Main overview page with key metrics
- **Requests** - Detailed request history and logs
- **Domain Stats** - Per-domain usage statistics
- **Token Usage** - Token consumption analytics
- **Prompts** - MCP prompt library
- **Help** - Setup guide for Claude Code client configuration

### URL Parameters

Many dashboard views support URL parameters:
Expand Down
5 changes: 5 additions & 0 deletions docs/06-Reference/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Added

- Help page for Claude Code client setup instructions
- Step-by-step configuration guide
- Environment variables documentation
- Troubleshooting section with common issues
- Command-line usage examples
- Conversation branching visualization in dashboard
- Message count tracking at database level for performance
- Branch-specific statistics in conversation view
Expand Down
1 change: 1 addition & 0 deletions services/dashboard/src/layout/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,7 @@ export const layout = (
<a href="/dashboard/usage" class="text-sm text-blue-600">Domain Stats</a>
<a href="/dashboard/token-usage" class="text-sm text-blue-600">Token Usage</a>
<a href="/dashboard/prompts" class="text-sm text-blue-600">Prompts</a>
<a href="/dashboard/help" class="text-sm text-blue-600">Help</a>
<span class="text-sm text-gray-600" id="current-domain">All Domains</span>
${
!auth.isReadOnly
Expand Down
2 changes: 2 additions & 0 deletions services/dashboard/src/routes/dashboard-api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import { tokenUsageRoutes } from './token-usage.js'
import { requestUsageRoutes } from './request-usage.js'
import { promptsRoute } from './prompts.js'
import { promptDetailRoute } from './prompt-detail.js'
import { helpRouter } from './help.js'

export const dashboardRoutes = new Hono<{
Variables: {
Expand All @@ -27,3 +28,4 @@ dashboardRoutes.route('/', tokenUsageRoutes)
dashboardRoutes.route('/', requestUsageRoutes)
dashboardRoutes.route('/prompts', promptsRoute)
dashboardRoutes.route('/prompts', promptDetailRoute)
dashboardRoutes.route('/help', helpRouter)
Loading