Documentation: Create comprehensive platform-specific user guides

[sfloess]

Overview

Create detailed user guides for each of the 7 interfaces (CLI, Swing, AWT, Terminal, Android, iOS, macOS) beyond the current README.

Current State

• ✅ Excellent README.md
• ✅ Comprehensive CLAUDE.md
• ✅ Good RUNNING.md
• ❌ No platform-specific guides
• ❌ No visual tutorials

Documentation Score Impact

Current: Documentation A (94/100)
With this + #68: Documentation A+ (99/100)

Proposed Documentation Structure

docs/
├── getting-started.md          # Quick start for all platforms (NEW)
├── guides/                     # Platform-specific guides (NEW)
│   ├── cli-guide.md
│   ├── swing-gui-guide.md
│   ├── awt-gui-guide.md
│   ├── terminal-ui-guide.md
│   ├── android-guide.md
│   ├── ios-guide.md
│   └── macos-guide.md
├── advanced/                   # Advanced topics (NEW)
│   ├── configuration-guide.md
│   ├── filtering-guide.md
│   ├── statistics-guide.md
│   ├── troubleshooting.md
│   └── best-practices.md
└── screenshots/                # Visual documentation (NEW)
    ├── swing-main.png
    ├── swing-stats.png
    ├── android-list.png
    ├── ios-search.png
    └── ...

Guide Content Template

Each guide should include:

1. Installation

• Platform-specific installation steps
• System requirements
• Dependency installation
• Verification steps

2. Getting Started

• First launch walkthrough
• Credential configuration
• Basic operations tutorial
• Common workflows

3. Features

• List view with screenshots
• Search/filter capabilities
• Statistics and analytics
• Settings and preferences

4. Keyboard Shortcuts

• Platform-specific shortcuts
• Navigation tips
• Efficiency tricks

5. Screenshots

• Main interface
• Settings screen
• Example searches
• Statistics views

6. Tips and Tricks

• Power user features
• Common patterns
• Performance optimization
• Troubleshooting

Specific Guide Outlines

CLI Guide (docs/guides/cli-guide.md)

# JNexus Command-Line Interface Guide

## Quick Start
```bash
# List components
jnexus list maven-releases

# Search with filters
jnexus list maven-releases --regex '.*SNAPSHOT.*' --min-size 1000000

# Delete with dry-run
jnexus delete maven-releases --regex '.*SNAPSHOT.*' --dry-run

# Repository statistics
jnexus stats maven-releases

Commands Reference

list

[Description, all flags, examples]

delete

[Description, safety features, examples]

stats

[Description, format options, examples]

Advanced Usage

Profiles

[How to use --profile flag]

Environment Variables

[Complete list of NEXUS_* variables]

Scripting Examples

[Bash/Python scripts using jnexus]

Troubleshooting

[Common errors and solutions]

### Swing GUI Guide (docs/guides/swing-gui-guide.md)

```markdown
# JNexus Swing GUI Guide

## Screenshots
![Main Window](../screenshots/swing-main.png)
![Statistics Dialog](../screenshots/swing-stats.png)

## Interface Tour
### Main Window
- Repository dropdown
- Regex filter field
- List/Refresh/Delete buttons
- Component table (sortable, multi-select)
- Status bar

### Advanced Filters Panel
- Size range filters
- Date range filters
- File extension filter
- Toggle button

### Statistics Dialog
- Overview tab
- Size distribution
- File types breakdown
- Age distribution
- Largest components

## Workflows
### Search for Large Files
1. Select repository
2. Click Advanced Filters
3. Set min-size: 10000000 (10MB)
4. Click List
5. Sort by File Size column

### Delete Old SNAPSHOTs
1. Enter regex: .*SNAPSHOT.*
2. Set created-before: 2025-01-01
3. Enable dry-run
4. Click Delete (preview)
5. Disable dry-run
6. Click Delete (confirm)

## Keyboard Shortcuts
- Enter: Trigger List
- Ctrl+R: Refresh
- Ctrl+D: Delete Selected
- Ctrl+S: Statistics
- Double-click row: Component Details

## Tips and Tricks
- Multi-select with Ctrl+Click or Shift+Click
- Sort by clicking column headers
- Summary row shows totals
- Right-click for context menu (future)

Android Guide (docs/guides/android-guide.md)

# JNexus Android App Guide

## Installation
1. Download APK from GitHub Releases
2. Enable "Install from Unknown Sources"
3. Install APK
4. Grant permissions if needed

## Screenshots
![List Screen](../screenshots/android-list.png)
![Search Screen](../screenshots/android-search.png)
![Stats Screen](../screenshots/android-stats.png)
![Settings Screen](../screenshots/android-settings.png)

## First Launch
### Configure Credentials
1. Open Settings tab
2. Enter Nexus URL, username, password
3. Tap Save
4. Credentials encrypted with AES-256-GCM

### List Components
1. Go to List tab
2. Select repository
3. Tap List or Refresh
4. Swipe down to refresh

## Features
### List Screen
- Repository dropdown
- List/Refresh buttons
- Component cards
- Swipe to delete
- Tap card for details

### Search Screen
- Advanced filters
- Collapsible sections
- Size/date/extension filters
- Clear filters button

### Stats Screen
- Repository analytics
- Size distribution
- File type breakdown
- Age distribution
- Largest components

### Settings Screen
- Credential management
- Repository list
- Default values
- HTTP timeout
- Security info

## Tips
- Pull to refresh
- Swipe left to delete
- Tap details to expand
- Long-press for context menu (future)

iOS Guide (docs/guides/ios-guide.md)

# JNexus iOS App Guide

## Installation
- Via App Store (future)
- Via TestFlight (beta)

## Screenshots
![List View](../screenshots/ios-list.png)
![Search View](../screenshots/ios-search.png)
![Stats View](../screenshots/ios-stats.png)
![Settings](../screenshots/ios-settings.png)

## Interface
### Tab Bar
- List
- Search
- Stats
- Settings

### Gestures
- Pull to refresh
- Swipe to delete
- Tap to expand details
- 3D Touch for quick actions (future)

### iPad Differences
- Split view in landscape
- Larger stat cards
- Multi-column layouts

macOS Guide (docs/guides/macos-guide.md)

# JNexus macOS App Guide

## Installation
- Via App Store (future)
- Direct download from GitHub

## Interface
### Sidebar Navigation
- Repository List
- Search
- Statistics
- Settings

### Menu Bar
- File → New Window
- Edit → Clear Cache
- View → Refresh
- Tools → Statistics

### Keyboard Shortcuts
- ⌘L: List
- ⌘R: Refresh
- ⌘F: Search
- ⌘,: Settings
- ⌘W: Close Window
- ⌘Q: Quit

### Multi-Window Support
- Open multiple repositories
- Compare statistics
- Independent caches

Configuration Guide (docs/advanced/configuration-guide.md)

# JNexus Configuration Guide

## nexus.properties File
Location: ~/.flossware/nexus/nexus.properties

## Required Settings
nexus.url=https://nexus.example.com
nexus.user=admin
nexus.password=secret

## Optional Settings
nexus.repositories=maven-releases,maven-snapshots
nexus.default.repository=maven-releases
nexus.default.regex=.*
nexus.default.dryrun=true
nexus.http.timeout.seconds=30

## Profile Support
Create profile-specific files:
- nexus-dev.properties
- nexus-prod.properties
- nexus-staging.properties

Use with --profile flag or NEXUS_PROFILE environment variable.

## Encryption
Desktop uses jencrypt for password encryption:
java -jar jencrypt.jar encrypt mypassword

Android uses EncryptedSharedPreferences (automatic).
iOS uses Keychain Services (automatic).

## Environment Variables
NEXUS_URL - Override nexus.url
NEXUS_USER - Override nexus.user
NEXUS_PASSWORD - Override nexus.password
NEXUS_PROFILE - Select profile
NEXUS_HTTP_TIMEOUT - Override timeout

Acceptance Criteria

• All 7 platform guides created
• 20+ screenshots captured
• Configuration guide complete
• Troubleshooting guide complete
• Best practices documented
• All guides reviewed for accuracy
• Links added to README.md
• Navigation between guides

Priority

Medium - Improves accessibility for new users

Related

• Documentation: Create comprehensive platform-specific user guides #68: Video tutorials (complements written guides)
• Documentation: No i18n/l10n support - all UI text is English-only #45: Documentation gaps (this fills many)