Skip to content

Commit dbc93f5

Browse files
committed
Rewrite Mintlify docs in-depth (29 pages), migrate mint.json to docs.json, fix broken /docs# anchor links, update files.md/changelog.md/task.md
1 parent dc25f0c commit dbc93f5

24 files changed

Lines changed: 2053 additions & 821 deletions

ONE-CLICK-DEPLOY.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -223,9 +223,9 @@ This happens when WorkOS CORS is not configured:
223223

224224
## Next steps
225225

226-
- [Full setup guide](https://www.opensync.dev/docs#hosting) for detailed configuration
227-
- [Plugin development guide](https://www.opensync.dev/docs#plugins) to build your own sync plugin
228-
- [API reference](https://www.opensync.dev/docs#api) for programmatic access
226+
- [Full setup guide](https://docs.opensync.dev/hosting/convex) for detailed configuration
227+
- [Plugin development guide](https://docs.opensync.dev/plugins/opencode-sync) to build your own sync plugin
228+
- [API reference](https://docs.opensync.dev/api/endpoints) for programmatic access
229229
- [install.md](install.md) for local development setup
230230

231231
## Need help?

README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Dashboards for OpenCode, Claude Code, Codex, Cursor, Factory Droid and more.
44

55
Cloud-synced dashboards that track session activity, tool usage, and token spend. Build eval datasets across projects.
66

7-
[Website](https://www.opensync.dev/) | [Docs](https://www.opensync.dev/docs) | [Dashboard](https://www.opensync.dev/)
7+
[Website](https://www.opensync.dev/) | [Docs](https://docs.opensync.dev) | [Dashboard](https://www.opensync.dev/)
88

99
## OpenSync Ecosystems
1010

@@ -22,12 +22,12 @@ Cloud-synced dashboards that track session activity, tool usage, and token spend
2222

2323
| Feature | Description |
2424
| ------------------------------------------------------- | ---------------------------------------------- |
25-
| [Sync](https://www.opensync.dev/docs#hosted-features) | Sessions sync in real time as you work |
26-
| [Search](https://www.opensync.dev/docs#search) | Full text, semantic, and hybrid search |
27-
| [Private](https://www.opensync.dev/docs#auth) | Your data stays in your account |
28-
| [Tag](https://www.opensync.dev/docs#dashboard-evals) | Organize sessions with custom labels for evals |
29-
| [Export](https://www.opensync.dev/docs#dashboard-evals) | DeepEval JSON, OpenAI Evals JSONL, plain text |
30-
| [Delete](https://www.opensync.dev/docs#hosted-features) | Your data, your control |
25+
| [Sync](https://docs.opensync.dev/getting-started/hosted) | Sessions sync in real time as you work |
26+
| [Search](https://docs.opensync.dev/search/fulltext) | Full text, semantic, and hybrid search |
27+
| [Private](https://docs.opensync.dev/auth/workos) | Your data stays in your account |
28+
| [Tag](https://docs.opensync.dev/dashboard/evals) | Organize sessions with custom labels for evals |
29+
| [Export](https://docs.opensync.dev/dashboard/evals) | DeepEval JSON, OpenAI Evals JSONL, plain text |
30+
| [Delete](https://docs.opensync.dev/getting-started/hosted) | Your data, your control |
3131

3232
## Quick start
3333

@@ -38,7 +38,7 @@ Cloud-synced dashboards that track session activity, tool usage, and token spend
3838
3. Install a sync plugin (see below)
3939
4. Start coding
4040

41-
[Full setup guide](https://www.opensync.dev/docs#hosted)
41+
[Full setup guide](https://docs.opensync.dev/getting-started/hosted)
4242

4343
### Install sync plugins
4444

@@ -57,7 +57,7 @@ Add to your `opencode.json`:
5757
}
5858
```
5959

60-
[OpenCode plugin docs](https://www.opensync.dev/docs#opencode-plugin)
60+
[OpenCode plugin docs](https://docs.opensync.dev/plugins/opencode-sync)
6161

6262
**For Claude Code:**
6363

@@ -66,7 +66,7 @@ npm install -g claude-code-sync
6666
claude-code-sync login
6767
```
6868

69-
[Claude Code plugin docs](https://www.opensync.dev/docs#claude-plugin)
69+
[Claude Code plugin docs](https://docs.opensync.dev/plugins/claude-code-sync)
7070

7171
**For Codex CLI:**
7272

@@ -75,7 +75,7 @@ npm install -g codex-sync
7575
codex-sync login
7676
```
7777

78-
[Codex CLI plugin docs](https://www.opensync.dev/docs#codex-plugin)
78+
[Codex CLI plugin docs](https://docs.opensync.dev/plugins/codex-sync)
7979

8080
**For Cursor:**
8181

@@ -84,7 +84,7 @@ npm install -g cursor-sync-plugin
8484
cursor-sync login
8585
```
8686

87-
[Cursor plugin docs](https://www.opensync.dev/docs#cursor-plugin)
87+
[Cursor plugin docs](https://docs.opensync.dev/plugins/cursor-sync)
8888

8989
**For Pi:**
9090

@@ -94,7 +94,7 @@ npm install -g pi-opensync-plugin
9494

9595
Then run `/opensync:config` in pi to configure the extension.
9696

97-
[Pi plugin docs](https://www.opensync.dev/docs#pi-plugin)
97+
[Pi plugin docs](https://github.com/joshuadavidthomas/pi-opensync-plugin)
9898

9999
## Self hosting
100100

@@ -109,7 +109,7 @@ npx convex dev
109109

110110
Requires Convex, WorkOS, and OpenAI accounts.
111111

112-
[Self hosting guide](https://www.opensync.dev/docs#hosting) | [Fork guide](https://www.opensync.dev/docs#fork) | [install.md](install.md)
112+
[Self hosting guide](https://docs.opensync.dev/hosting/convex) | [Fork guide](https://docs.opensync.dev/fork/guide) | [install.md](install.md)
113113

114114
### One-click deploy
115115

@@ -126,12 +126,12 @@ Four views for managing your sessions:
126126

127127
| View | What it does |
128128
| -------------------------------------------------------------- | -------------------------------------------------- |
129-
| [Overview](https://www.opensync.dev/docs#dashboard-overview) | Usage stats, token charts, recent sessions |
130-
| [Sessions](https://www.opensync.dev/docs#dashboard-sessions) | Filter, search, and manage all sessions |
131-
| [Evals](https://www.opensync.dev/docs#dashboard-evals) | Mark sessions as eval-ready, export datasets |
132-
| [Analytics](https://www.opensync.dev/docs#dashboard-analytics) | Model comparison, project breakdown, cost tracking |
129+
| [Overview](https://docs.opensync.dev/dashboard/overview) | Usage stats, token charts, recent sessions |
130+
| [Sessions](https://docs.opensync.dev/dashboard/sessions) | Filter, search, and manage all sessions |
131+
| [Evals](https://docs.opensync.dev/dashboard/evals) | Mark sessions as eval-ready, export datasets |
132+
| [Analytics](https://docs.opensync.dev/dashboard/analytics) | Model comparison, project breakdown, cost tracking |
133133

134-
[Context search](https://www.opensync.dev/docs#dashboard-context) lets you find relevant sessions for RAG and context engineering.
134+
[Context search](https://docs.opensync.dev/dashboard/context) lets you find relevant sessions for RAG and context engineering.
135135

136136
## API
137137

@@ -146,7 +146,7 @@ All endpoints require authentication. Generate an API key in Settings.
146146
| `GET /api/context?q=` | Get context for LLM |
147147
| `GET /api/export?id=` | Export session |
148148

149-
[Full API reference](https://www.opensync.dev/docs#api)
149+
[Full API reference](https://docs.opensync.dev/api/endpoints)
150150

151151
## Tech stack
152152

changelog.md

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,31 @@ Format based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
66

77
## [Unreleased]
88

9-
### Changed
10-
11-
- Migrated all in-app documentation to Mintlify at docs.opensync.dev
12-
- Removed Docs.tsx (full in-app documentation page with sidebar, search, and markdown export)
13-
- Removed src/lib/search.ts (client-side search index builder for docs)
14-
- Removed src/search-index.json (pre-built search index data)
15-
- Removed src/mdx.d.ts (MDX type declarations)
16-
- All /docs, /docs/*, and /docs-legacy routes now redirect externally to docs.opensync.dev
17-
- Added DocsRedirect component in App.tsx for client-side redirect
18-
- Updated Sidebar.tsx docs link to point to external docs.opensync.dev
19-
- Platform Stats header now displays "last 1000 sessions" label for clarity
20-
- Users know the leaderboard data is based on recent activity, not all-time totals
21-
22-
### Fixed
23-
24-
- Fixed Netlify build error: Stats.tsx was git-ignored causing module not found error
25-
- Removed src/pages/Stats.tsx from .gitignore so placeholder page is included in build
26-
- Updated Stats.tsx header comment to reflect it's no longer git-ignored
27-
- Fixed Netlify build error caused by removed Docs.tsx import references
28-
- Cleaned up all imports of deleted files (search.ts, search-index.json, mdx.d.ts)
29-
309
### Added
3110

11+
- Comprehensive Mintlify documentation rewrite with in-depth technical content
12+
- Created docs.json (replacing mint.json) with new Mintlify schema, navigation groups, and correct GitHub URLs
13+
- Created index.mdx landing page with CardGroup links to all documentation sections
14+
- Rewrote getting-started/hosted.mdx with supported tools table, step-by-step setup, what gets synced, privacy details
15+
- Rewrote getting-started/requirements.mdx with cloud vs local deployment, architecture overview, env var reference
16+
- Rewrote dashboard/overview.mdx with schema field mapping, filter details, real-time update explanation
17+
- Rewrote dashboard/sessions.mdx with full data model table, filtering, sorting, message parts, bulk actions
18+
- Rewrote dashboard/evals.mdx with eval workflow, labels, metadata fields, three export formats with examples
19+
- Rewrote dashboard/analytics.mdx with cost formula, model pricing table, token breakdown, trend charts
20+
- Rewrote dashboard/context.mdx with embedding internals, API examples, RAG use cases
21+
- Rewrote plugins/opencode-sync.mdx with setup steps, commands, syncing internals, schema mapping, troubleshooting
22+
- Rewrote plugins/claude-code-sync.mdx with setup, commands, session data mapping, troubleshooting
23+
- Rewrote plugins/codex-sync.mdx with supported models, pricing, troubleshooting
24+
- Rewrote plugins/cursor-sync.mdx with supported models, what gets synced, privacy notes
25+
- Rewrote api/endpoints.mdx with full sync/query/search/export/context endpoint reference and request/response examples
26+
- Rewrote search/fulltext.mdx with indexing details, syntax, ranking, comparison with semantic
27+
- Rewrote search/semantic.mdx with embedding model, storage schema, examples, requirements
28+
- Rewrote search/hybrid.mdx with scoring formula, RAG pipeline example, comparison table
29+
- Rewrote auth/workos.mdx with auth flow, user provisioning schema, redirect URIs, CORS, troubleshooting
30+
- Rewrote hosting/convex.mdx with schema tables, indexes, HTTP endpoints, monitoring, scaling
31+
- Fixed broken /docs#anchor links in README.md, ONE-CLICK-DEPLOY.md, and Login.tsx (mapped to new Mintlify paths)
32+
- Fixed /docs/fork/contribute link in FAQ
33+
- Added Pi and Factory Droid to supported tools in FAQ
3234
- pi-opensync-plugin community plugin support (syncs Pi coding agent sessions)
3335
- Added "pi" to SourceType union with orange PI badge (#f97316)
3436
- Added Pi to Login page "Syncs with" section with SVG icon

0 commit comments

Comments
 (0)