Skip to content

docs: update documentation to reflect cross-platform support#54

Merged
ashishkurmi merged 4 commits intostep-security:mainfrom
swarit-stepsecurity:swarit/chore/update-docs-coverage
May 4, 2026
Merged

docs: update documentation to reflect cross-platform support#54
ashishkurmi merged 4 commits intostep-security:mainfrom
swarit-stepsecurity:swarit/chore/update-docs-coverage

Conversation

@swarit-stepsecurity
Copy link
Copy Markdown
Member

What does this PR do?

Type of change

  • Bug fix
  • Enhancement
  • Documentation

Testing

  • Tested on macOS (version: ___)
  • Binary runs without errors: ./stepsecurity-dev-machine-guard --verbose
  • JSON output is valid: ./stepsecurity-dev-machine-guard --json | python3 -m json.tool
  • No secrets or credentials included
  • Lint passes: make lint
  • Tests pass: make test

Related Issues

…ent codebase

- Remove "macOS only" from Known Limitations; document macOS + Windows support
- Add Windows download instructions to Quick Start (README, community-mode)
- Update scheduled scanning references: launchd (macOS) + schtasks (Windows)
- Add schtasks/ to project structure
- Add Windows paths to IDE detection table (SCAN_COVERAGE.md)
- Add Windows paths to MCP config tables (SCAN_COVERAGE.md, mcp-audit.md)
- Add cross-platform notes to CLI tools, agents, frameworks, extensions
- Fix JSON schema: add agent_url, node_packages, correct mcp_configs field names
- Add missing IDE types (openvsx) and flags (--search-dirs, --disable-npm-scan)
- Update adding-detections guide with actual struct fields and Windows patterns
- Replace jq filtering description with Go-native filtering (mcp-audit.md)
- Remove hardcoded version numbers from examples
- Add Linux to all platform references (was missing entirely)
- Add all JetBrains IDEs back to SCAN_COVERAGE IDE table with 3-column layout
- Add systemd to all scheduled scanning references (was incorrectly listed as "on the roadmap")
- Add Homebrew, Python, and System Package scanning sections to SCAN_COVERAGE
- Add Windsurf, Antigravity, JetBrains, Eclipse, Xcode plugin detection to extensions section
- Add 6 missing CLI flags to README and community-mode docs
- Add 13 missing JSON fields and 6 summary counts to reading-scan-results schema
- Add 15 missing IDE types to reading-scan-results reference
- Fix Known Limitations to reflect actual state (remove false "macOS only" and "on the roadmap" claims)
- Add Linux release binary download instructions (incl. deb/rpm)
- Update configuration table (brew scan, python scan, log level)
Keep our version which has Linux detection column, expanded
IDE extensions section (Windsurf, Antigravity, Eclipse, Xcode),
and cross-platform MCP config paths.
@ashishkurmi ashishkurmi removed their request for review May 4, 2026 20:22
@ashishkurmi ashishkurmi merged commit f5d1983 into step-security:main May 4, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants