Skip to content

Commit 909c977

Browse files
authored
docs: conciseness review - cut filler, fix errors, remove duplicates (#686)
* docs: trim filler, fix errors, cut duplicate sections across 22 files * docs: deep review round 2 - cut 281 more lines, fix factual errors
1 parent 3744150 commit 909c977

30 files changed

Lines changed: 103 additions & 639 deletions

docs/customization/editor-settings.mdx

Lines changed: 2 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,7 @@ The font picker shows installed monospaced families on your Mac.
3535
| **Monaco** | Traditional Mac programming font |
3636
| **Courier New** | Cross-platform standard |
3737

38-
<Tip>
39-
**System Mono** automatically uses the best available system monospace font.
40-
</Tip>
41-
42-
If a saved font is no longer available, TablePro falls back to System Mono.
38+
Falls back to System Mono if a saved font is unavailable.
4339

4440
{/* Screenshot: Font family selector */}
4541
<Frame caption="Font family selector with available fonts">
@@ -75,15 +71,6 @@ If a saved font is no longer available, TablePro falls back to System Mono.
7571
/>
7672
</Frame>
7773

78-
**Recommendations**:
79-
80-
| Size | Best For |
81-
|------|----------|
82-
| 11-12 pt | Small screens, seeing more code |
83-
| 13-14 pt | Standard usage (default) |
84-
| 15-16 pt | Better readability |
85-
| 17-18 pt | Large screens, accessibility |
86-
8774
## Display Settings
8875

8976
### Line Numbers
@@ -157,14 +144,6 @@ If a saved font is no longer available, TablePro falls back to System Mono.
157144
|---------|---------|---------|
158145
| Tab Width | 1-16 spaces | 4 |
159146

160-
Common choices:
161-
162-
| Width | Usage |
163-
|-------|-------|
164-
| 2 spaces | Compact, JavaScript-style |
165-
| 4 spaces | Standard SQL formatting (recommended) |
166-
| 8 spaces | Traditional Unix-style |
167-
168147
{/* Screenshot: Tab width setting */}
169148
<Frame caption="Tab width setting for indentation">
170149
<img
@@ -216,14 +195,12 @@ SELECT
216195
| **Off** | Keywords stay as typed (default) |
217196
| **On** | SQL keywords auto-uppercase when you type a space or delimiter |
218197

219-
When enabled, recognized SQL keywords (`select`, `from`, `where`, `join`, etc.) are converted to uppercase as soon as you type a word boundary character (space, tab, newline, parenthesis, comma, or semicolon). Keywords inside strings, comments, and backtick-quoted identifiers are left unchanged.
198+
SQL keywords auto-uppercase on word boundaries. Keywords inside strings, comments, and quoted identifiers are unaffected.
220199

221200
### Autocomplete
222201

223202
Autocomplete is always on. Dismiss with `Escape`. See [Autocomplete](/features/autocomplete) for details.
224203

225-
All editor settings apply immediately. No restart required.
226-
227204
## Keyboard Shortcuts
228205

229206
| Action | Shortcut |

docs/customization/settings.mdx

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -411,19 +411,24 @@ Manage database driver plugins from the **Plugins** tab in Settings.
411411

412412
Split-view: plugin list on the left, details on the right. Each row shows version, capability, and source (built-in or user-installed). Filter by name using the search field.
413413

414-
TablePro ships with 3 built-in database driver plugins (MySQL, PostgreSQL, SQLite) and 3 built-in export plugins (CSV, JSON, SQL). Additional plugins are available from the plugin registry and can be installed from the Browse tab or downloaded automatically when you select a database type:
414+
TablePro ships with 6 built-in database driver plugins (MySQL, PostgreSQL, SQLite, ClickHouse, SQL Server, Redis) and 3 built-in export plugins (CSV, JSON, SQL). Additional plugins are available from the plugin registry and can be installed from the Browse tab or downloaded automatically when you select a database type:
415415

416416
| Plugin | Database Types | Default Port | Distribution |
417417
|--------|---------------|--------------|--------------|
418418
| MySQL | MySQL, MariaDB | 3306 | Built-in |
419419
| PostgreSQL | PostgreSQL, Redshift | 5432 | Built-in |
420420
| SQLite | SQLite | -- | Built-in |
421-
| ClickHouse | ClickHouse | 8123 | Registry |
422-
| SQL Server | SQL Server | 1433 | Registry |
421+
| ClickHouse | ClickHouse | 8123 | Built-in |
422+
| SQL Server | SQL Server | 1433 | Built-in |
423+
| Redis | Redis | 6379 | Built-in |
423424
| MongoDB | MongoDB | 27017 | Registry |
424-
| Redis | Redis | 6379 | Registry |
425425
| DuckDB | DuckDB | -- | Registry |
426426
| Oracle | Oracle | 1521 | Registry |
427+
| Cassandra | Cassandra, ScyllaDB | 9042 | Registry |
428+
| Etcd | Etcd | 2379 | Registry |
429+
| Cloudflare D1 | Cloudflare D1 | -- | Registry |
430+
| DynamoDB | DynamoDB | -- | Registry |
431+
| BigQuery | BigQuery | -- | Registry |
427432

428433
Toggle plugins on/off in the detail pane. Disabled plugins hide their database type from the connection dialog.
429434

docs/databases/cloudflare-d1.mdx

Lines changed: 2 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -71,26 +71,7 @@ Store your API token securely. TablePro saves it in the macOS Keychain, but the
7171

7272
### Create a D1 Database
7373

74-
If you don't have a D1 database yet:
75-
76-
```bash
77-
# Install Wrangler CLI
78-
npm install -g wrangler
79-
80-
# Login to Cloudflare
81-
wrangler login
82-
83-
# Create a database
84-
wrangler d1 create my-app-db
85-
86-
# Seed with test data
87-
wrangler d1 execute my-app-db --remote \
88-
--command "CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT, email TEXT)"
89-
wrangler d1 execute my-app-db --remote \
90-
--command "INSERT INTO users VALUES (1, 'Alice', 'alice@example.com')"
91-
```
92-
93-
You can also create databases directly from TablePro using the **Create Database** button in the database switcher.
74+
Create databases with `wrangler d1 create my-app-db` or from TablePro's **Create Database** button.
9475

9576
## Example Configuration
9677

@@ -160,13 +141,7 @@ Export query results or table data to CSV, JSON, SQL, and other formats.
160141

161142
## SQL Dialect
162143

163-
D1 uses SQLite's SQL syntax. Key points:
164-
165-
- **Identifier quoting**: Double quotes (`"column_name"`)
166-
- **String literals**: Single quotes (`'value'`)
167-
- **Auto-increment**: `INTEGER PRIMARY KEY AUTOINCREMENT`
168-
- **Type affinity**: SQLite's flexible type system applies
169-
- **PRAGMA support**: Most SQLite PRAGMAs work (`PRAGMA table_info`, `PRAGMA foreign_key_list`, etc.)
144+
D1 uses SQLite syntax. See [SQLite](/databases/sqlite) for details.
170145

171146
## Troubleshooting
172147

docs/databases/connection-urls.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Every supported database URL scheme, format, and query parameter fo
55

66
# Connection URL Reference
77

8-
TablePro parses standard database connection URLs for importing connections, opening them directly from a browser or terminal, and configuring SSH tunnels. This page covers every supported scheme, format, and query parameter.
8+
TablePro parses standard database connection URLs for importing connections, opening them directly from a browser or terminal, and configuring SSH tunnels.
99

1010
## URL Schemes
1111

docs/databases/overview.mdx

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ description: Create, organize, and manage database connections across 18+ suppor
55

66
# Connection Management
77

8-
TablePro connects to 18+ database systems. Create connections, organize them with colors, tags, and groups, and switch between them instantly.
9-
108
## Supported Databases
119

1210
Natively supported:
@@ -359,9 +357,9 @@ For MySQL, MariaDB, and PostgreSQL, TablePro pings (`SELECT 1`) every **30 secon
359357

360358
When a connection drops, TablePro reconnects with exponential backoff:
361359

362-
1. **Attempt 1** -- waits 2 seconds, then reconnects
363-
2. **Attempt 2** -- waits 4 seconds, then reconnects
364-
3. **Attempt 3** -- waits 8 seconds, then reconnects
360+
1. **Attempt 1**: waits 2 seconds, then reconnects
361+
2. **Attempt 2**: waits 4 seconds, then reconnects
362+
3. **Attempt 3**: waits 8 seconds, then reconnects
365363

366364
After three failures, the connection enters an error state. A **Reconnect** button appears in the toolbar.
367365

@@ -395,7 +393,7 @@ SQLite connections are file-based and don't require health monitoring or auto-re
395393

396394
## Startup Commands
397395

398-
SQL statements that run automatically on every connection. Use them to set session variables, timezone, encoding, or other session options.
396+
SQL statements that run automatically on every connection.
399397

400398
Configure startup commands in the **Advanced** tab of the connection form. Enter one SQL statement per line.
401399

@@ -416,12 +414,12 @@ Set a timezone here to ensure datetime results are consistent across team member
416414
</Tip>
417415

418416
<Note>
419-
Startup commands run on every connection, including auto-reconnects. They are database-specific: use MySQL syntax for MySQL connections, PostgreSQL syntax for PostgreSQL, and so on.
417+
Startup commands run on every connection, including auto-reconnects.
420418
</Note>
421419

422420
## Editing and Deleting Connections
423421

424-
Right-click a connection to edit or delete it. Changes take effect on the next connection. Deleting removes the saved settings only; your database is unaffected.
422+
Right-click a connection to edit or delete it. Changes take effect on the next connection. Deleting removes the saved settings only.
425423

426424
## Backup and Restore
427425

docs/databases/sqlite.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ SQLite is a self-contained, file-based database engine. No server required. The
1515
</Step>
1616
</Steps>
1717

18-
File-based database, no server/auth required. Double-click `.duckdb` files in Finder to open directly.
18+
File-based database, no server/auth required. Double-click `.sqlite`/`.db`/`.sqlite3` files in Finder to open directly.
1919

2020
## Common Locations
2121

docs/databases/ssh-tunneling.mdx

Lines changed: 1 addition & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,6 @@ flowchart LR
3030
TablePro -->|"Encrypted<br>Tunnel"| Jump -->|"Internal<br>Network"| Database
3131
```
3232

33-
1. TablePro opens an SSH connection to your jump server
34-
2. A local port (e.g., 60000) forwards through the tunnel
35-
3. All traffic between your Mac and the SSH server is encrypted
36-
4. The SSH server connects to the database on your behalf
37-
3833
## When to Use SSH Tunneling
3934

4035
- Database in private network
@@ -337,51 +332,7 @@ Jump hosts only support **Private Key** and **SSH Agent** authentication. Passwo
337332

338333
## SSH Key Setup
339334

340-
### Generating SSH Keys
341-
342-
If you don't have SSH keys:
343-
344-
```bash
345-
# Generate a new key pair
346-
ssh-keygen -t ed25519 -C "your_email@example.com"
347-
348-
# Or use RSA for broader compatibility
349-
ssh-keygen -t rsa -b 4096 -C "your_email@example.com"
350-
```
351-
352-
### Key Locations
353-
354-
Default key locations on macOS:
355-
356-
| Key Type | Private Key | Public Key |
357-
|----------|-------------|------------|
358-
| Ed25519 | `~/.ssh/id_ed25519` | `~/.ssh/id_ed25519.pub` |
359-
| RSA | `~/.ssh/id_rsa` | `~/.ssh/id_rsa.pub` |
360-
| ECDSA | `~/.ssh/id_ecdsa` | `~/.ssh/id_ecdsa.pub` |
361-
362-
### Adding Key to Server
363-
364-
Copy your public key to the SSH server:
365-
366-
```bash
367-
# Using ssh-copy-id
368-
ssh-copy-id -i ~/.ssh/id_ed25519.pub user@server
369-
370-
# Or manually
371-
cat ~/.ssh/id_ed25519.pub | ssh user@server "mkdir -p ~/.ssh && cat >> ~/.ssh/authorized_keys"
372-
```
373-
374-
### Key Permissions
375-
376-
SSH keys must have correct permissions:
377-
378-
```bash
379-
# Fix permissions
380-
chmod 700 ~/.ssh
381-
chmod 600 ~/.ssh/id_*
382-
chmod 644 ~/.ssh/id_*.pub
383-
chmod 644 ~/.ssh/config
384-
```
335+
Generate keys: `ssh-keygen -t ed25519`. Copy to server: `ssh-copy-id user@server`. Keys must be `chmod 600`.
385336

386337
## Import from URL
387338

0 commit comments

Comments
 (0)