Sync help documentation from main repository

Synced from: 855a47efb1f33e3f767ebf83bf683136ea5e9414
Date: 2025-12-29 02:20:52 UTC

Author: andytriboletti

404.md

@@ -11,14 +11,14 @@ Sorry, the page you're looking for doesn't exist.
 
 - [Go to Help Home](/help/) - Browse all help topics
 - [Search Help](/help/) - Use the search box to find what you need
-- [Getting Started](/help/mas/getting-started) - Start here if you're new
+- [Getting Started](/help/mas/getting-started) (macOS) or [Getting Started](/help/windows/getting-started) (Windows) - Start here if you're new
 - [Back to CodeFrog](https://codefrog.app) - Return to main site
 
 ## Common Pages:
 
-- [Keyboard Shortcuts](/help/mas/shortcuts)
-- [Project Workflows](/help/mas/workflows)
-- [Troubleshooting](/help/mas/troubleshooting)
+- [Keyboard Shortcuts](/help/common/shortcuts)
+- [Project Workflows](/help/common/workflows)
+- [Troubleshooting](/help/common/troubleshooting)
 - [Complete Feature List](/help/)
 
 If you believe this is an error, please [contact support](https://greenrobot.freshdesk.com/support/solutions/9000119001).

_data/nav.yml

@@ -11,6 +11,12 @@ items:
       - "/help/mas/"
       - "/help/mas/index.html"
 
+  - title: "Windows Help"
+    url: "/help/windows/"
+    match_paths:
+      - "/help/windows/"
+      - "/help/windows/index.html"
+  
   # Mac-specific documentation
   - title: "Mac: Getting Started"
     url: "/help/mas/getting-started"

assets/css/help.css

@@ -146,7 +146,7 @@ body {
   width: 260px;
   background: var(--help-sidebar);
   border-right: 1px solid #e5e5e7;
-  padding: 1rem 1rem;
+  padding: 1rem 0.5rem 1rem 0.5rem;
   position: sticky;
   top: 60px; /* Account for compact header */
   height: calc(100vh - 60px);
@@ -173,7 +173,7 @@ body {
 .help-nav a {
   color: #0051a5;
   text-decoration: none;
-  padding: 0.4rem 0.5rem;
+  padding: 0.4rem 0.5rem 0.4rem 0;
   border-radius: 4px;
   display: block;
   transition: all 0.2s ease;

help/common/tips.md

@@ -94,6 +94,10 @@ Windows OpenSSH stores keys in a specific location:
 
 **Key Management**:
 - Generate new key: `ssh-keygen -t ed25519 -C "your_email@example.com"`
+  - **Note**: This requires OpenSSH to be installed. Windows 10/11 include OpenSSH by default, but if `ssh-keygen` is not available, you can:
+    - Enable OpenSSH via Settings → Apps → Optional Features → OpenSSH Client
+    - Use WSL (Windows Subsystem for Linux) if available
+    - Use an alternative tool like PuTTYgen for SSH key generation
 - Set proper permissions: Right-click private key → Properties → Security → Remove all users except your account
 - Add public key to servers: Copy content of `.pub` file to server's `~/.ssh/authorized_keys`
 
@@ -111,6 +115,7 @@ CodeFrog's code analysis uses OpenGrep, which requires specific DLL files:
 - If you see "missing DLL" errors:
   1. Close CodeFrog completely
   2. Delete the binaries cache folder (typically located at `C:\Users\YourUsername\AppData\Local\CodeFrog\Cache\Binaries`)
+     - **Note**: The cache path may vary depending on your installation method (portable vs. installer) or CodeFrog's configuration. If the standard path doesn't exist, check CodeFrog's settings or logs to locate the cache directory.
   3. Restart CodeFrog - it will re-extract DLLs
 
 ## AI Assistant Guidance

help/mas/shortcuts.md

@@ -98,5 +98,5 @@ layout: help
 
 ## Next Steps
 
-- [Troubleshooting](/help/mas/troubleshooting) - Find solutions to common issues
+- [Troubleshooting](/help/common/troubleshooting) - Find solutions to common issues
 

help/mas/tips.md

@@ -27,7 +27,7 @@ Get the most out of CodeFrog with these platform-specific tips and AI assistant
 - **⌘T**: Open terminal
 - **⌘P**: Quick file search
 
-See the [Keyboard Shortcuts](/help/mas/shortcuts) guide for the complete list.
+See the [Keyboard Shortcuts](/help/common/shortcuts) guide for the complete list.
 
 ### Menu Bar Integration
 
@@ -111,6 +111,6 @@ For a complete list of recommended tools and services that work well with CodeFr
 
 - [Getting Started Guide](/help/mas/getting-started) - Learn the basics
 - [Project Workflows](/help/common/workflows) - Choose your workflow
-- [Keyboard Shortcuts](/help/mas/shortcuts) - Boost productivity
-- [Troubleshooting](/help/mas/troubleshooting) - Solve common issues
+- [Keyboard Shortcuts](/help/common/shortcuts) - Boost productivity
+- [Troubleshooting](/help/common/troubleshooting) - Solve common issues
 

help/mas/troubleshooting.md

@@ -133,5 +133,6 @@ layout: help
 - [Getting Started Guide](/help/mas/getting-started) - Basic setup instructions
 - [macOS Setup](/help/mas/macos-setup) - Detailed macOS configuration
 - [Project Workflows](/help/common/workflows) - Understanding local vs. remote workflows
+- [Tips for New Users](/help/common/tips) - Productivity tips and best practices
 - [Send Feedback](https://greenrobot.freshdesk.com/support/solutions/9000119001) - Contact support
 

index.md

@@ -34,26 +34,26 @@ This is the authoritative, comprehensive list of all CodeFrog features. Use this
 
 ## Getting Started
 
-- [Getting Started Guide](/help/mas/getting-started) - Quick start guide for new users
-- [Project Workflows](/help/mas/workflows) - Learn about local and remote development
-- [Keyboard Shortcuts](/help/mas/shortcuts) - Master CodeFrog's keyboard shortcuts
+- [Getting Started Guide](/help/mas/getting-started) (macOS) or [Getting Started Guide](/help/windows/getting-started) (Windows) - Quick start guide for new users
+- [Project Workflows](/help/common/workflows) - Learn about local and remote development
+- [Keyboard Shortcuts](/help/common/shortcuts) - Master CodeFrog's keyboard shortcuts
 
 ## Advanced Features
 
-- [Accessibility Testing](/help/mas/accessibility) - WCAG AA compliance testing
-- [Security Scanning](/help/mas/security) - Comprehensive security validation
-- [OSV / Supply Chain](/help/mas/osv) - Open Source Vulnerability detection
-- [Secrets Detection](/help/mas/secrets) - Gitleaks integration for secrets scanning
+- [Accessibility Testing](/help/common/accessibility) - WCAG AA compliance testing
+- [Security Scanning](/help/common/security) - Comprehensive security validation
+- [OSV / Supply Chain](/help/common/osv) - Open Source Vulnerability detection
+- [Secrets Detection](/help/common/secrets) - Gitleaks integration for secrets scanning
 
 ## AI & Automation
 
-- [CodeRabbit + Augment Workflow](/help/mas/ai-coder-coderabbit-augment) - Automated code review workflow
-- [Cursor / Other AI Agents](/help/mas/ai-coder-cursor) - Using Cursor and other AI tools
+- [CodeRabbit + Augment Workflow](/help/common/ai-coder-coderabbit-augment) - Automated code review workflow
+- [Cursor / Other AI Agents](/help/common/ai-coder-cursor) - Using Cursor and other AI tools
 
 ## Launch & Quality
 
-- [Launch Checklist](/help/mas/launch-checklist) - Pre-launch verification steps
-- [Troubleshooting](/help/mas/troubleshooting) - Common issues and solutions
+- [Launch Checklist](/help/common/launch-checklist) - Pre-launch verification steps
+- [Troubleshooting](/help/common/troubleshooting) - Common issues and solutions
 
 ---
 

scripts/check_links.py

@@ -80,12 +80,24 @@ def check_links(help_dir: Path) -> Tuple[int, int, int, int, List[str]]:
     external_links = 0
     broken_list = []
 
-    # Find all markdown files
+    # Get help-docs root directory to check root index.md
+    help_docs_dir = help_dir.parent
+    
+    # Find all markdown files in help/ directory
     md_files = list(help_dir.rglob("*.md"))
 
+    # Also check root index.md if it exists
+    root_index = help_docs_dir / "index.md"
+    if root_index.exists():
+        md_files.append(root_index)
+    
     for md_file in md_files:
-        # Get relative path from help directory
-        rel_path = md_file.relative_to(help_dir)
+        # Get relative path - handle both help/ subdirectory and root files
+        try:
+            rel_path = md_file.relative_to(help_dir)
+        except ValueError:
+            # File is outside help_dir (like root index.md)
+            rel_path = md_file.relative_to(help_docs_dir)
 
         # Read file content
         try: