Skip to content

docs: document report formats and CSV header-only behavior#135

Open
kavya-seth-vns wants to merge 2 commits into
OWASP:mainfrom
kavya-seth-vns:docs/report-formats-readme
Open

docs: document report formats and CSV header-only behavior#135
kavya-seth-vns wants to merge 2 commits into
OWASP:mainfrom
kavya-seth-vns:docs/report-formats-readme

Conversation

@kavya-seth-vns

Copy link
Copy Markdown

📖 Documentation Update: Report Formats

✨ Summary

This pull request improves the README by documenting DockSec's supported report formats in a dedicated Report Formats section.

✅ What's Included

  • Added a dedicated Report Formats section to the README.
  • Documented the supported output formats:
    • JSON – Machine-readable output for automation.
    • CSV – Tabular output for spreadsheets and reporting.
    • PDF – Human-readable report for sharing.
    • HTML – Interactive browser-based report.
  • Clarified the expected header-only CSV behavior when no findings are present.
  • Added references to the existing Machine-readable Output and SARIF Output sections instead of duplicating information.
  • Maintained consistency with the existing README structure and writing style.

📝 Type of Change

  • Documentation update

✅ Testing

  • Verified Markdown formatting renders correctly.
  • Verified internal links and section references.
  • Reviewed for grammar, consistency, and readability.

Environment

  • Operating System: Windows 11
  • Python Version: N/A
  • DockSec Version: Current main branch

✔️ Checklist

  • Documentation updated
  • Self-review completed
  • No warnings or errors introduced
  • Spelling and formatting checked
  • Follows the project's documentation style

Closes #132

Thank you for reviewing this contribution! 🚀

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jul 3, 2026
@advaitpatel

Copy link
Copy Markdown
Collaborator

@kavya-seth-vns thank you for your PR however some other contributor has made the same changes. Could you please find any other issue and raise your PR again? Thank you!

@kavya-seth-vns

Copy link
Copy Markdown
Author

@advaitpatel
Thank you for the clarification! I appreciate your feedback.

I'll look for another issue and submit a new PR soon.

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[GOOD FIRST ISSUE] Document --format output formats and CSV header-only behavior in README

2 participants