updating documentations#74
Merged
Merged
Conversation
Collaborator
advaitpatel
commented
May 6, 2026
advaitpatel
commented
- Value Proposition: Refined the "What is DockSec?" section to clearly highlight the "Plain English" and "Actionable Fixes" benefits, making it more compelling for media and new users.
- Improved Onboarding: Reorganized the Installation and Quick Start sections to be more logical and copy-paste friendly.
- Privacy & Security: Added a explicit note about Privacy First design, clarifying that code is scanned locally and only metadata is shared with AI providers.
- Multi-LLM Clarity: Simplified the configuration instructions for different AI providers (OpenAI, Claude, Gemini, Ollama).
- Structural Accuracy: Updated all internal commands (like tool installation) to reflect the new package structure (python -m docksec.setup_external_tools).
- Visual Polish: Added a "Quick Links" section at the top and improved the formatting of tables and lists for better readability.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.