Skip to content

jin0x/mind-os-dashboard

Repository files navigation

Mind OS Dashboard

A read-only Next.js dashboard that renders an Obsidian vault as a real-time project management UI. Think "local Linear" for AI agent workflows — kanban boards, epic tracking, activity feeds, decision logs, and observation cards, all powered by markdown files.

Features

  • Kanban Story Board — Stories parsed from PROGRESS.md, displayed in Ready / In Progress / In Review / Completed columns
  • Epic Tracking — Progress bars, story counts, status badges from epic markdown files
  • Activity Feed — Agent activity logs (STORY_START, COMMIT, PR_CREATED, etc.) parsed from ACTIVITY.md
  • Decision Log — Structured decisions parsed from DECISIONS.md with MDX-rendered sections
  • Observation Cards — Severity-tagged observations with category filtering
  • MDX Rendering — Full markdown rendering with syntax highlighting, GFM tables, task lists, Obsidian callouts, and wikilink resolution
  • Command Palette — Cmd+K search across all entities (projects, stories, epics, observations)
  • Real-time Updates — File watcher (chokidar) → SSE → automatic page refresh on vault changes
  • Entity Cross-linking — Every card, entry, and ID is clickable and resolves to its detail page

Quick Start

# Install dependencies
npm install

# Configure vault path
cp .env.example .env.local
# Edit .env.local to point to your Mind OS vault

# Start dev server
npm run dev

Open http://localhost:3000.

Tech Stack

  • Framework: Next.js 16 (App Router, React 19, Turbopack)
  • Language: TypeScript
  • Styling: Tailwind CSS 4 + shadcn/ui (dark mode)
  • MDX: next-mdx-remote/rsc + shiki + rehype-pretty-code + remark-gfm
  • Real-time: chokidar file watcher → Server-Sent Events
  • Search: cmdk command palette with debounced API search

Vault Structure

The dashboard expects a Mind OS vault with this layout:

Mind OS/
├── 00-System/
│   └── registries/
│       └── PROJECT-REGISTRY.yaml
├── 01-Operations/
│   ├── projects/
│   │   └── {slug}/
│   │       ├── STATUS.md          # Project metadata (frontmatter)
│   │       ├── PROGRESS.md        # Story board (kanban sections)
│   │       ├── ACTIVITY.md        # Agent activity log
│   │       ├── DECISIONS.md       # Decision records
│   │       └── epics/
│   │           └── E001-*.md      # Epic definitions
│   └── observations/
│       └── OBS-NNN-*.md           # Observations

Routes

Route Description
/ Dashboard — stats, project cards, recent activity
/projects Project list
/projects/[slug] Project detail with MDX-rendered STATUS.md
/projects/[slug]/progress Kanban story board
/projects/[slug]/epics Epic list
/projects/[slug]/epics/[epicId] Epic detail
/projects/[slug]/stories/[storyId] Story detail
/projects/[slug]/decisions Decision log
/projects/[slug]/activity Project activity feed
/activity Global activity feed
/observations Observation list
/observations/[id] Observation detail

Documentation

License

Private — not for redistribution.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors