Skip to content

Commit d636724

Browse files
airtonixairtonix
committed
style(docs): apply prettier formatting updates
1 parent 0d87096 commit d636724

3 files changed

Lines changed: 126 additions & 89 deletions

File tree

‎docs/INDEX.md‎

Lines changed: 90 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,15 @@ Complete guide to Jot documentation, organized for quick navigation by use case,
1111
Choose your path:
1212

1313
**Path A: Beginner (No SQL)**
14+
1415
- **Time**: 15 minutes | **Goal**: Get comfortable with basic note management
1516
- 1. Start: [Getting Started: Beginner's Guide](getting-started-basics.md) - Simple intro
1617
- 2. Then: Create notebooks and manage notes naturally
1718
- 3. When ready: Graduate to [Getting Started for Power Users](getting-started-power-users.md)
1819
- **Result**: You can manage, search, and organize your notes ✅
1920

2021
**Path B: Power User (With SQL)**
22+
2123
- **Time**: 15 minutes | **Goal**: Get productive with SQL queries
2224
- 1. Start: [Getting Started for Power Users](getting-started-power-users.md) - Complete 15-minute onboarding
2325
- 2. Then: [Import Workflow Guide](import-workflow-guide.md) - Understand how to organize your notes
@@ -92,6 +94,7 @@ Choose the guide that matches your current need:
9294
- Follow after: README quick start or complete basics guide
9395

9496
### Importing Notes
97+
9598
- **[Import Workflow Guide](import-workflow-guide.md)** (2,200 words, 20 min read)
9699
- Perfect for: Anyone migrating from other tools
97100
- Contains: Import process, organization patterns, migration guides
@@ -100,6 +103,7 @@ Choose the guide that matches your current need:
100103
- Follow after: Getting started guide
101104

102105
### Learning SQL
106+
103107
- **[SQL Quick Reference](sql-quick-reference.md)** (2,400 words, 4 learning levels)
104108
- Perfect for: Progressive SQL learning
105109
- Level 1: Basic queries (5 examples)
@@ -110,27 +114,31 @@ Choose the guide that matches your current need:
110114
- Follow after: Getting started guide
111115

112116
### Advanced SQL & Functions
117+
113118
- **[SQL Guide](sql-guide.md)** (21 KB, comprehensive reference)
114119
- Perfect for: Building complex queries
115120
- Contains: Complete DuckDB SQL documentation
116121
- Advanced patterns: CTEs, aggregations, window functions
117122
- See also: [SQL Functions Reference](sql-functions-reference.md)
118123

119124
### SQL Functions Reference
125+
120126
- **[SQL Functions Reference](sql-functions-reference.md)** (12.7 KB, API reference)
121127
- Perfect for: Function syntax and parameters
122128
- Contains: `read_markdown()`, `md_stats()`, all markdown functions
123129
- Lookup format: Alphabetical by function
124130
- Follow up with: [SQL Guide](sql-guide.md) for examples
125131

126132
### JSON & Data Transformation
133+
127134
- **[JSON-SQL Guide](json-sql-guide.md)** (23.8 KB, integration guide)
128135
- Perfect for: Piping to jq, external tools
129136
- Contains: JSON export patterns, jq examples, tool integration
130137
- Use case: Automation, data pipelines, external processing
131138
- Related: [Automation Recipes](automation-recipes.md)
132139

133140
### Automation & Scripts
141+
134142
- **[Automation Recipes](automation-recipes.md)** (2,850+ words, practical guide)
135143
- Perfect for: Ready-to-use scripts and patterns
136144
- Contains: 5+ production-ready shell scripts
@@ -139,13 +147,15 @@ Choose the guide that matches your current need:
139147
- Uses: [SQL Quick Reference](sql-quick-reference.md) for queries
140148

141149
### Multi-Notebook Management
150+
142151
- **[Notebook Discovery](notebook-discovery.md)** (6.9 KB, reference)
143152
- Perfect for: Managing multiple notebooks
144153
- Contains: Auto-discovery patterns, configuration
145154
- Use cases: Team setups, multi-project, personal/work separation
146155
- Related: Getting started guide (create notebook section)
147156

148157
### Troubleshooting
158+
149159
- **[Getting Started Troubleshooting Guide](getting-started-troubleshooting.md)** (3,700+ words, problem-solver)
150160
- Perfect for: Resolving issues
151161
- Contains: 6 major problem categories
@@ -158,6 +168,7 @@ Choose the guide that matches your current need:
158168
## 🎓 Learning Paths
159169

160170
### Beginner (30 minutes)
171+
161172
Goal: Import notes and run your first query
162173

163174
1. **[Getting Started for Power Users](getting-started-power-users.md)** (15 min)
@@ -171,6 +182,7 @@ Goal: Import notes and run your first query
171182
---
172183

173184
### Power User (2 hours)
185+
174186
Goal: Master import, SQL queries, and automation patterns
175187

176188
1. **[Getting Started for Power Users](getting-started-power-users.md)** (15 min)
@@ -194,6 +206,7 @@ Goal: Master import, SQL queries, and automation patterns
194206
---
195207

196208
### Expert (4+ hours)
209+
197210
Goal: Complete mastery of all features and patterns
198211

199212
1. **All beginner and power user content** (2 hours)
@@ -229,59 +242,61 @@ Goal: Complete mastery of all features and patterns
229242

230243
### By Topic
231244

232-
| Topic | Best Guide | Key Sections |
233-
|-------|-----------|--------------|
234-
| **Import** | [Import Workflow Guide](import-workflow-guide.md) | Step-by-step, organization patterns, migrations |
235-
| **SQL Basics** | [SQL Quick Reference](sql-quick-reference.md) | Levels 1-2, examples, common mistakes |
236-
| **SQL Advanced** | [SQL Guide](sql-guide.md) | CTEs, aggregations, window functions |
237-
| **Functions** | [SQL Functions Reference](sql-functions-reference.md) | read_markdown(), md_stats(), all functions |
238-
| **Automation** | [Automation Recipes](automation-recipes.md) | Scripts, cron, jq, tool integration |
239-
| **JSON Output** | [JSON-SQL Guide](json-sql-guide.md) | JSON export, jq examples, pipelines |
240-
| **Multi-Notebook** | [Notebook Discovery](notebook-discovery.md) | Auto-discovery, multiple notebooks |
241-
| **Problems** | [Getting Started Troubleshooting Guide](getting-started-troubleshooting.md) | Error solutions, performance, debugging |
242-
| **Onboarding** | [Getting Started for Power Users](getting-started-power-users.md) | 15-minute overview, all basics |
245+
| Topic | Best Guide | Key Sections |
246+
| ------------------ | --------------------------------------------------------------------------- | ----------------------------------------------- |
247+
| **Import** | [Import Workflow Guide](import-workflow-guide.md) | Step-by-step, organization patterns, migrations |
248+
| **SQL Basics** | [SQL Quick Reference](sql-quick-reference.md) | Levels 1-2, examples, common mistakes |
249+
| **SQL Advanced** | [SQL Guide](sql-guide.md) | CTEs, aggregations, window functions |
250+
| **Functions** | [SQL Functions Reference](sql-functions-reference.md) | read_markdown(), md_stats(), all functions |
251+
| **Automation** | [Automation Recipes](automation-recipes.md) | Scripts, cron, jq, tool integration |
252+
| **JSON Output** | [JSON-SQL Guide](json-sql-guide.md) | JSON export, jq examples, pipelines |
253+
| **Multi-Notebook** | [Notebook Discovery](notebook-discovery.md) | Auto-discovery, multiple notebooks |
254+
| **Problems** | [Getting Started Troubleshooting Guide](getting-started-troubleshooting.md) | Error solutions, performance, debugging |
255+
| **Onboarding** | [Getting Started for Power Users](getting-started-power-users.md) | 15-minute overview, all basics |
243256

244257
### By Feature
245258

246-
| Feature | Best Guide | Details |
247-
|---------|-----------|---------|
248-
| **SELECT queries** | [SQL Quick Reference](sql-quick-reference.md) - Level 1 | Basic queries and LIMIT |
249-
| **Search queries** | [SQL Quick Reference](sql-quick-reference.md) - Level 2 | LIKE, wildcards, text search |
250-
| **Metadata** | [SQL Quick Reference](sql-quick-reference.md) - Level 3 | Word count, line count, analysis |
251-
| **Complex queries** | [SQL Quick Reference](sql-quick-reference.md) - Level 4 | GROUP BY, ORDER BY, aggregates |
252-
| **Functions** | [SQL Functions Reference](sql-functions-reference.md) | Function parameters and returns |
253-
| **read_markdown()** | [SQL Functions Reference](sql-functions-reference.md) | File reading and patterns |
254-
| **md_stats()** | [SQL Functions Reference](sql-functions-reference.md) | Metadata extraction |
255-
| **JSON output** | [JSON-SQL Guide](json-sql-guide.md) | JSON export patterns |
256-
| **jq integration** | [JSON-SQL Guide](json-sql-guide.md) | jq pipelines and examples |
257-
| **Import workflow** | [Import Workflow Guide](import-workflow-guide.md) | From any source |
258-
| **Obsidian import** | [Import Workflow Guide](import-workflow-guide.md) | Obsidian-specific steps |
259-
| **Bear import** | [Import Workflow Guide](import-workflow-guide.md) | Bear-specific steps |
260-
| **Daily reports** | [Automation Recipes](automation-recipes.md) | note-stats.sh, cron |
261-
| **Weekly summaries** | [Automation Recipes](automation-recipes.md) | weekly-note-summary.sh |
262-
| **Backups** | [Automation Recipes](automation-recipes.md) | note-backup.sh, git |
263-
| **Export** | [Automation Recipes](automation-recipes.md) | note-export.sh, formats |
259+
| Feature | Best Guide | Details |
260+
| -------------------- | ------------------------------------------------------- | -------------------------------- |
261+
| **SELECT queries** | [SQL Quick Reference](sql-quick-reference.md) - Level 1 | Basic queries and LIMIT |
262+
| **Search queries** | [SQL Quick Reference](sql-quick-reference.md) - Level 2 | LIKE, wildcards, text search |
263+
| **Metadata** | [SQL Quick Reference](sql-quick-reference.md) - Level 3 | Word count, line count, analysis |
264+
| **Complex queries** | [SQL Quick Reference](sql-quick-reference.md) - Level 4 | GROUP BY, ORDER BY, aggregates |
265+
| **Functions** | [SQL Functions Reference](sql-functions-reference.md) | Function parameters and returns |
266+
| **read_markdown()** | [SQL Functions Reference](sql-functions-reference.md) | File reading and patterns |
267+
| **md_stats()** | [SQL Functions Reference](sql-functions-reference.md) | Metadata extraction |
268+
| **JSON output** | [JSON-SQL Guide](json-sql-guide.md) | JSON export patterns |
269+
| **jq integration** | [JSON-SQL Guide](json-sql-guide.md) | jq pipelines and examples |
270+
| **Import workflow** | [Import Workflow Guide](import-workflow-guide.md) | From any source |
271+
| **Obsidian import** | [Import Workflow Guide](import-workflow-guide.md) | Obsidian-specific steps |
272+
| **Bear import** | [Import Workflow Guide](import-workflow-guide.md) | Bear-specific steps |
273+
| **Daily reports** | [Automation Recipes](automation-recipes.md) | note-stats.sh, cron |
274+
| **Weekly summaries** | [Automation Recipes](automation-recipes.md) | weekly-note-summary.sh |
275+
| **Backups** | [Automation Recipes](automation-recipes.md) | note-backup.sh, git |
276+
| **Export** | [Automation Recipes](automation-recipes.md) | note-export.sh, formats |
264277

265278
### By Audience
266279

267-
| Audience | Start Here | Then | Finally |
268-
|----------|-----------|------|---------|
269-
| **New User** | [Getting Started for Power Users](getting-started-power-users.md) | [SQL Quick Reference](sql-quick-reference.md) | [Automation Recipes](automation-recipes.md) |
270-
| **Migrating User** | [Import Workflow Guide](import-workflow-guide.md) | [Getting Started for Power Users](getting-started-power-users.md) | [SQL Quick Reference](sql-quick-reference.md) |
271-
| **SQL Developer** | [SQL Quick Reference](sql-quick-reference.md) | [SQL Guide](sql-guide.md) | [SQL Functions Reference](sql-functions-reference.md) |
272-
| **Automation Developer** | [Automation Recipes](automation-recipes.md) | [JSON-SQL Guide](json-sql-guide.md) | [SQL Quick Reference](sql-quick-reference.md) |
273-
| **Troubleshooter** | [Getting Started Troubleshooting Guide](getting-started-troubleshooting.md) | Related guide based on issue | [Getting Started Troubleshooting Guide](getting-started-troubleshooting.md) FAQ |
274-
| **Team Lead** | [Notebook Discovery](notebook-discovery.md) | [Getting Started for Power Users](getting-started-power-users.md) | [Import Workflow Guide](import-workflow-guide.md) |
280+
| Audience | Start Here | Then | Finally |
281+
| ------------------------ | --------------------------------------------------------------------------- | ----------------------------------------------------------------- | ------------------------------------------------------------------------------- |
282+
| **New User** | [Getting Started for Power Users](getting-started-power-users.md) | [SQL Quick Reference](sql-quick-reference.md) | [Automation Recipes](automation-recipes.md) |
283+
| **Migrating User** | [Import Workflow Guide](import-workflow-guide.md) | [Getting Started for Power Users](getting-started-power-users.md) | [SQL Quick Reference](sql-quick-reference.md) |
284+
| **SQL Developer** | [SQL Quick Reference](sql-quick-reference.md) | [SQL Guide](sql-guide.md) | [SQL Functions Reference](sql-functions-reference.md) |
285+
| **Automation Developer** | [Automation Recipes](automation-recipes.md) | [JSON-SQL Guide](json-sql-guide.md) | [SQL Quick Reference](sql-quick-reference.md) |
286+
| **Troubleshooter** | [Getting Started Troubleshooting Guide](getting-started-troubleshooting.md) | Related guide based on issue | [Getting Started Troubleshooting Guide](getting-started-troubleshooting.md) FAQ |
287+
| **Team Lead** | [Notebook Discovery](notebook-discovery.md) | [Getting Started for Power Users](getting-started-power-users.md) | [Import Workflow Guide](import-workflow-guide.md) |
275288

276289
---
277290

278291
## 📖 Related Resources
279292

280293
### In README
294+
281295
- **Main README**: Quick start, features, installation, basic usage
282296
- **See README for**: Features overview, installation instructions, basic commands
283297

284298
### CLI Help Commands
299+
285300
```bash
286301
# Full help
287302
jot --help
@@ -304,21 +319,25 @@ jot notes search --help # See --sql flag documentation
304319
## 🛠️ How to Use This Index
305320

306321
### Option 1: Find by Use Case
322+
307323
1. Go to [Quick Start by Use Case](#-quick-start-by-use-case)
308324
2. Find your situation
309325
3. Follow the recommended path
310326

311327
### Option 2: Find by Learning Level
328+
312329
1. Go to [Learning Paths](#-learning-paths)
313330
2. Choose your level (Beginner, Power User, Expert)
314331
3. Follow the suggested reading order
315332

316333
### Option 3: Search by Topic
334+
317335
1. Go to [Search This Documentation](#-search-this-documentation)
318336
2. Find your topic in the table
319337
3. Go to the recommended guide
320338

321339
### Option 4: Browse All Guides
340+
322341
- See [Documentation by Purpose](#-documentation-by-purpose)
323342
- All guides listed with descriptions
324343
- Choose based on your current need
@@ -356,18 +375,21 @@ jot notes search --help # See --sql flag documentation
356375
### Code Blocks
357376

358377
**Bash/Shell**:
378+
359379
```bash
360380
jot notebook create "MyNotebook" --path ~/my-notes
361381
```
362382

363383
**SQL**:
384+
364385
```sql
365386
SELECT file_path, md_stats(content).words as words
366387
FROM read_markdown()
367388
ORDER BY words DESC
368389
```
369390

370391
**JSON Output**:
392+
371393
```json
372394
{
373395
"file_path": "notes/example.md",
@@ -377,13 +399,13 @@ ORDER BY words DESC
377399

378400
### Callout Boxes
379401

380-
| Symbol | Meaning |
381-
|--------|---------|
382-
| ✅ | Recommended approach or best practice |
383-
| ❌ | Don't do this / common mistake |
384-
| ⚠️ | Important warning or caution |
385-
| 💡 | Helpful tip or shortcut |
386-
| 🚀 | Advanced or power user feature |
402+
| Symbol | Meaning |
403+
| ------ | ------------------------------------- |
404+
| ✅ | Recommended approach or best practice |
405+
| ❌ | Don't do this / common mistake |
406+
| ⚠️ | Important warning or caution |
407+
| 💡 | Helpful tip or shortcut |
408+
| 🚀 | Advanced or power user feature |
387409

388410
### Links
389411

@@ -395,18 +417,18 @@ ORDER BY words DESC
395417

396418
## 🔗 Quick Navigation
397419

398-
| Need | Link |
399-
|------|------|
400-
| **15-min onboarding** | [Getting Started for Power Users](getting-started-power-users.md) |
401-
| **Import guides** | [Import Workflow Guide](import-workflow-guide.md) |
402-
| **SQL learning (Levels 1-4)** | [SQL Quick Reference](sql-quick-reference.md) |
403-
| **Advanced SQL** | [SQL Guide](sql-guide.md) |
404-
| **Function reference** | [SQL Functions Reference](sql-functions-reference.md) |
405-
| **Automation scripts** | [Automation Recipes](automation-recipes.md) |
406-
| **JSON & jq** | [JSON-SQL Guide](json-sql-guide.md) |
407-
| **Multi-notebooks** | [Notebook Discovery](notebook-discovery.md) |
408-
| **Troubleshooting** | [Getting Started Troubleshooting Guide](getting-started-troubleshooting.md) |
409-
| **Back to README** | [README.md](../README.md) |
420+
| Need | Link |
421+
| ----------------------------- | --------------------------------------------------------------------------- |
422+
| **15-min onboarding** | [Getting Started for Power Users](getting-started-power-users.md) |
423+
| **Import guides** | [Import Workflow Guide](import-workflow-guide.md) |
424+
| **SQL learning (Levels 1-4)** | [SQL Quick Reference](sql-quick-reference.md) |
425+
| **Advanced SQL** | [SQL Guide](sql-guide.md) |
426+
| **Function reference** | [SQL Functions Reference](sql-functions-reference.md) |
427+
| **Automation scripts** | [Automation Recipes](automation-recipes.md) |
428+
| **JSON & jq** | [JSON-SQL Guide](json-sql-guide.md) |
429+
| **Multi-notebooks** | [Notebook Discovery](notebook-discovery.md) |
430+
| **Troubleshooting** | [Getting Started Troubleshooting Guide](getting-started-troubleshooting.md) |
431+
| **Back to README** | [README.md](../README.md) |
410432

411433
---
412434

@@ -417,41 +439,45 @@ After using this documentation, you should be able to:
417439
✅ **Beginner**: Import notes and run a basic SELECT query
418440
✅ **Power User**: Automate reports and integrate with external tools
419441
✅ **Expert**: Build complex queries and custom workflows
420-
✅ **All Levels**: Troubleshoot issues and find answers quickly
442+
✅ **All Levels**: Troubleshoot issues and find answers quickly
421443

422444
---
423445

424446
## 📝 Document Information
425447

426-
| Item | Details |
427-
|------|---------|
428-
| **Updated** | 2026-01-20 |
429-
| **Guides** | 9 comprehensive guides |
430-
| **Total Content** | 50,000+ words |
431-
| **Code Examples** | 100+ working examples |
448+
| Item | Details |
449+
| ------------------ | -------------------------------- |
450+
| **Updated** | 2026-01-20 |
451+
| **Guides** | 9 comprehensive guides |
452+
| **Total Content** | 50,000+ words |
453+
| **Code Examples** | 100+ working examples |
432454
| **Learning Paths** | 3 (Beginner, Power User, Expert) |
433455

434456
---
435457

436458
## 🚀 Ready to Get Started?
437459

438460
### First Time Here?
461+
439462
→ Go to [Getting Started for Power Users](getting-started-power-users.md)
440463

441464
### Migrating from Another Tool?
465+
442466
→ Go to [Import Workflow Guide](import-workflow-guide.md)
443467

444468
### Want to Learn SQL?
469+
445470
→ Go to [SQL Quick Reference](sql-quick-reference.md)
446471

447472
### Need Help?
473+
448474
→ Go to [Getting Started Troubleshooting Guide](getting-started-troubleshooting.md)
449475

450476
### Want to Automate?
477+
451478
→ Go to [Automation Recipes](automation-recipes.md)
452479

453480
---
454481

455482
**Last Updated**: 2026-01-20
456483
**Status**: Complete documentation suite ready for all users
457-

0 commit comments

Comments
 (0)