Skip to content

Commit 88a7f41

Browse files
Sync help documentation from main repository
Synced from: 1820fc7b654dc983655abc2c7508e431b6c72723 Date: 2025-12-29 00:02:12 UTC
1 parent 8b2f735 commit 88a7f41

6 files changed

Lines changed: 42 additions & 198 deletions

File tree

_data/nav.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,6 @@ items:
3636
- "/help/mas/shortcuts/"
3737
- "/help/mas/shortcuts.html"
3838

39-
- title: "Tools Available"
40-
url: "/help/mas/tools"
41-
match_paths:
42-
- "/help/mas/tools/"
43-
- "/help/mas/tools.html"
44-
4539
- title: "Troubleshooting"
4640
url: "/help/mas/troubleshooting"
4741
match_paths:
@@ -68,6 +62,12 @@ items:
6862
- "/help/windows/windows-troubleshooting.html"
6963

7064
# Common/Cross-platform documentation
65+
- title: "Tools Available"
66+
url: "/help/common/tools"
67+
match_paths:
68+
- "/help/common/tools/"
69+
- "/help/common/tools.html"
70+
7171
- title: "Project Workflows"
7272
url: "/help/common/workflows"
7373
match_paths:

help/common/server-management.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -333,6 +333,6 @@ See platform-specific troubleshooting guides for more detailed troubleshooting g
333333

334334
- [Project Workflows](/help/common/workflows) - Setting up local and remote projects
335335
- [macOS Setup Guide](/help/mas/macos-setup) - macOS configuration for local SSH
336-
- [Tools Available](/help/mas/tools) - Overview of all CodeFrog tools
336+
- [Tools Available](/help/common/tools) - Overview of all CodeFrog tools
337337
- [Troubleshooting](/help/mas/troubleshooting) - Common issues and solutions
338338

Lines changed: 33 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,12 @@
22
title: Tools Available
33
redirect_from:
44
- /help/tools.php
5+
- /help/tools.php?flavor=mas
56
- /help/tools.php?flavor=windows
7+
- /help/mas/tools.php
68
- /help/windows/tools.php
9+
- /help/mas/tools
10+
- /help/windows/tools
711
layout: help
812
---
913

@@ -60,7 +64,7 @@ Comprehensive web testing suite for validating websites and web applications:
6064
- Analyze page performance
6165
- Verify meta tags
6266

63-
See [Accessibility Testing](/help/windows/accessibility) for detailed accessibility guidance.
67+
See [Accessibility Testing](/help/common/accessibility) for detailed accessibility guidance.
6468

6569
## Bulk Security Scanner
6670

@@ -119,15 +123,19 @@ Analyze your codebase for quality and security:
119123
- **Static Analysis**: Integration with code quality tools
120124
- **Secrets Detection**: Gitleaks integration for secrets scanning
121125
- **OSV Integration**: Open Source Vulnerability detection
122-
- **Exclusions**: Automatically exclude build directories, node_modules, etc.
126+
- **Exclusions**: Automatically exclude build directories, node_modules, Pods, .dart_tool, etc.
123127

124-
### Windows-Specific Notes
128+
### Platform-Specific Notes
125129

126-
- **OpenGrep Dependencies**: Code analysis uses OpenGrep which requires DLL files (libgmp-10.dll, etc.)
130+
**Windows:**
131+
- **OpenGrep Dependencies**: Code analysis uses OpenGrep which requires DLL files (libgmp-10.dll, libstdc++-6.dll, libgcc_s_seh-1.dll)
127132
- **DLL Management**: DLLs are automatically extracted with the binary
128133
- **Path Length**: Ensure long path support is enabled for deep directory structures
129134
- See [Windows Troubleshooting](/help/windows/windows-troubleshooting) if you encounter DLL errors
130135

136+
**macOS:**
137+
- Exclusions automatically handle macOS-specific build artifacts (Pods, .dart_tool, etc.)
138+
131139
### Use Cases
132140

133141
- Code quality metrics
@@ -151,13 +159,18 @@ GitHub integration for viewing and importing PR comments and issues:
151159

152160
**Note:** CodeFrog does NOT support git operations (commit, push, pull, diff viewing, branch detection). Use [GitHub Desktop](https://desktop.github.com/) or your preferred Git client for version control.
153161

154-
### Windows-Specific Setup
162+
### Platform-Specific Setup
155163

164+
**Windows:**
156165
- **SSH Keys**: Store in `C:\Users\YourUsername\.ssh\`
157166
- **Credential Management**: Windows Credential Manager stores Git credentials
158167
- **GitHub CLI**: Optional - can be installed separately for advanced workflows
159168
- See [GitHub Integration](/help/windows/github-integration) for Windows-specific setup
160169

170+
**macOS:**
171+
- SSH keys stored in `~/.ssh/`
172+
- See [GitHub Integration](/help/common/github) for general setup
173+
161174
### Use Cases
162175

163176
- Import PR comments for AI coding assistants
@@ -171,7 +184,7 @@ All tools are accessible from:
171184

172185
1. **Welcome Screen**: Quick access buttons for main tools
173186
2. **Navigation Menu**: Full list of all available tools
174-
3. **Keyboard Shortcuts**: Fast navigation (see [Shortcuts](/help/windows/shortcuts))
187+
3. **Keyboard Shortcuts**: Fast navigation (see [macOS Shortcuts](/help/mas/shortcuts) or [Windows Shortcuts](/help/windows/shortcuts))
175188

176189
## Tool Combinations
177190

@@ -182,28 +195,37 @@ All tools are accessible from:
182195
- **Code Review**: Code Analysis + GitHub Integration
183196
- **Server Monitoring**: Server Management + Terminal Access
184197

185-
## Windows-Specific Considerations
198+
## Platform-Specific Considerations
186199

187200
### Terminal Integration
188201

202+
**Windows:**
189203
- **Windows Terminal**: Recommended for best experience
190204
- **PowerShell**: Pre-installed, works well
191205
- **Command Prompt**: Basic support available
192206
- See [Windows Setup Guide](/help/windows/windows-setup) for terminal configuration
193207

208+
**macOS:**
209+
- Uses system Terminal with full support
210+
- See [macOS Setup Guide](/help/mas/macos-setup) for configuration
211+
194212
### File Path Handling
195213

214+
**Windows:**
196215
- **Long Paths**: Enable long path support for deep directory structures
197216
- **Case Sensitivity**: Windows is case-insensitive (unlike macOS/Linux)
198217
- **Path Formats**: Standard Windows paths and UNC network paths supported
199218
- See [Windows Tips](/help/windows/tips) for path handling tips
200219

220+
**macOS:**
221+
- Standard Unix-style paths
222+
- Case-sensitive file system (depending on APFS configuration)
223+
201224
## Next Steps
202225

203-
- [Getting Started](/help/windows/getting-started) - Learn the basics
204-
- [Project Workflows](/help/windows/workflows) - Set up your workflow
226+
- [Getting Started](/help/mas/getting-started) (macOS) or [Getting Started](/help/windows/getting-started) (Windows) - Learn the basics
227+
- [Project Workflows](/help/common/workflows) - Set up your workflow
205228
- [Security Scanning](/help/common/security) - Deep dive into security tools
206229
- [WCAG Levels Explained](/help/common/wcag-levels) - Understanding WCAG A, AA, and AAA conformance levels
207-
- [Accessibility Testing](/help/windows/accessibility) - WCAG compliance guide
208-
- [Windows Setup Guide](/help/windows/windows-setup) - Configure CodeFrog on Windows
230+
- [Accessibility Testing](/help/common/accessibility) - WCAG compliance guide
209231

help/mas/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Welcome to the CodeFrog help documentation for Mac App Store users.
1717
- [Tips for New Users](/help/mas/tips) - Platform-specific tips and AI assistant guidance
1818
- [Project Workflows](/help/common/workflows) - Learn about local and remote development
1919
- [Keyboard Shortcuts](/help/mas/shortcuts) - Master CodeFrog's keyboard shortcuts
20-
- [Tools Available](/help/mas/tools) - Overview of all available tools
20+
- [Tools Available](/help/common/tools) - Overview of all available tools
2121

2222
## Core Features
2323

help/mas/tools.md

Lines changed: 0 additions & 178 deletions
This file was deleted.

help/windows/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Welcome to the CodeFrog help documentation for Windows users.
1717
- [Tips for New Users](/help/windows/tips) - Windows-specific tips and AI assistant guidance
1818
- [Project Workflows](/help/windows/workflows) - Learn about local and remote development on Windows
1919
- [Keyboard Shortcuts](/help/windows/shortcuts) - Master CodeFrog's keyboard shortcuts
20-
- [Tools Available](/help/windows/tools) - Overview of all available tools
20+
- [Tools Available](/help/common/tools) - Overview of all available tools
2121

2222
## Windows-Specific Guides
2323

0 commit comments

Comments
 (0)