Skip to content

Commit 7445898

Browse files
committed
update README.md and DESIGN.md
1 parent 224020e commit 7445898

2 files changed

Lines changed: 32 additions & 39 deletions

File tree

DESIGN.md

Lines changed: 27 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ octowatch/
2828
│ │ └── +page.svelte # Individual group monitoring
2929
│ ├── lib/
3030
│ │ ├── components/ # Reusable UI components
31-
│ │ │ ├── RefreshButton.svelte # Legacy refresh component
31+
│ │ │ ├── RefreshButton.svelte # Manual refresh component
3232
│ │ │ └── HeaderActions.svelte # Coordinated refresh & settings buttons
3333
│ │ ├── services/ # API and business logic
3434
│ │ │ ├── github-api.ts # GitHub API client
@@ -93,7 +93,7 @@ The dashboard uses a **unified table approach** with collapsible functionality:
9393
**Supporting Components**:
9494

9595
- `HeaderActions.svelte` - Reusable coordinated refresh and settings buttons
96-
- `RefreshButton.svelte` - Legacy refresh component (deprecated)
96+
- `RefreshButton.svelte` - Manual refresh component
9797
- Configuration and API services in `src/lib/services/`
9898

9999
### Collapsible Repository View
@@ -159,6 +159,7 @@ interface Config {
159159
api_url: string;
160160
};
161161
dashboard: {
162+
title?: string;
162163
refresh_interval: number;
163164
max_runs_to_fetch: number;
164165
show_statuses: string[];
@@ -291,33 +292,31 @@ interface Repository {
291292

292293
## Configuration Examples
293294

294-
### Basic Setup
295+
### Repository Groups (Recommended)
295296

296297
```yaml
297-
repositories:
298-
- name: "my-app"
299-
owner: "mycompany"
300-
url: "https://github.com/mycompany/my-app"
301-
branch: "main"
298+
repository_groups:
299+
- name: "Frontend Projects"
300+
slug: "frontend"
301+
description: "Web applications and UI libraries"
302302
enabled: true
303-
```
304-
305-
### Multiple Repositories
306-
307-
```yaml
308-
repositories:
309-
- name: "frontend"
310-
owner: "mycompany"
311-
branch: "main"
312-
enabled: true
313-
- name: "backend"
314-
owner: "mycompany"
315-
branch: "develop"
316-
enabled: true
317-
- name: "mobile-app"
318-
owner: "mycompany"
319-
branch: "main"
320-
enabled: false
303+
repositories:
304+
- name: "my-app"
305+
owner: "mycompany"
306+
url: "https://github.com/mycompany/my-app"
307+
branch: "main"
308+
enabled: true
309+
310+
# Dashboard settings
311+
dashboard:
312+
title: "My Project Dashboard"
313+
refresh_interval: 30
314+
max_runs_to_fetch: 20
315+
show_statuses: ["success", "failure", "in_progress"]
316+
317+
# GitHub API settings
318+
github:
319+
api_url: "https://api.github.com"
321320
```
322321
323322
## Deployment Considerations
@@ -326,12 +325,12 @@ repositories:
326325
327326
- Compatible with Vercel, Netlify, GitHub Pages
328327
- Requires CORS configuration for GitHub API calls
329-
- Environment variables for GitHub tokens
328+
- Tokens managed via browser localStorage through Settings UI
330329
331330
### Security
332331
333332
- Never commit GitHub tokens to repository
334-
- Use environment variables for sensitive data
333+
- Tokens stored securely in browser localStorage
335334
- Implement proper CORS policies
336335
- Consider using GitHub Apps for enhanced security
337336
- Client-side token storage uses browser localStorage (secure for SPA)

README.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -175,15 +175,6 @@ The dashboard includes a settings panel (gear icon) where you can:
175175
- **Dependabot Filtering**: Choose to hide workflows triggered by Dependabot
176176
- Settings are automatically saved to localStorage and persist across sessions
177177

178-
### Environment Variables
179-
180-
You can also use environment variables:
181-
182-
```bash
183-
export GITHUB_TOKEN=your_github_token_here
184-
npm run dev
185-
```
186-
187178
## Repository Configuration Options
188179

189180
| Field | Description | Required |
@@ -209,9 +200,12 @@ npm run dev
209200
src/
210201
├── routes/
211202
│ ├── +layout.svelte # Main application layout
212-
│ └── +page.svelte # Dashboard home page
203+
│ ├── +page.svelte # Dashboard home page
204+
│ └── groups/[slug]/ # Individual group pages
205+
│ └── +page.svelte
213206
├── lib/
214207
│ ├── components/ # Reusable UI components
208+
│ │ ├── HeaderActions.svelte
215209
│ │ └── RefreshButton.svelte
216210
│ ├── services/ # API and business logic
217211
│ │ ├── github-api.ts # GitHub API integration
@@ -272,7 +266,7 @@ The dashboard uses color coding with **smart status aggregation**:
272266

273267
**Rate limit exceeded**:
274268

275-
- Add a GitHub personal access token to `config.yaml`
269+
- Add a GitHub personal access token via the Settings panel (gear icon)
276270
- Reduce the number of monitored repositories
277271
- Increase the refresh interval
278272

0 commit comments

Comments
 (0)