docs: improve README clarity and consistency #487
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Update main README to position Code Pathfinder as AI-Native SAST for modern security teams - Expand use cases: CVE detection, MCP server for AI assistants, in-editor checks, CI/CD - Explain AST/CFG/DFG terminology for better understanding - Restructure "Components" to "Tools and workflows" with detailed descriptions - Add MCP server links (codepathfinder.dev/mcp) in relevant sections - Standardize terminology: "Python DSL" → "Python SDK" across all docs - Simplify SecureFlow extension and CLI READMEs for better readability - Remove promotional language and make content more direct and actionable Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
SafeDep Report Summary
No dependency changes detected. Nothing to scan. This report is generated by SafeDep Github App |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #487 +/- ##
=======================================
Coverage 81.18% 81.18%
=======================================
Files 113 113
Lines 13016 13016
=======================================
Hits 10567 10567
Misses 2057 2057
Partials 392 392 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Improves documentation across all README files for better clarity and consistency.
Changes: