Skip to content

Enhance documentation with comprehensive README and Mermaid diagrams#15

Merged
brunojppb merged 3 commits intomainfrom
docs
Jul 30, 2025
Merged

Enhance documentation with comprehensive README and Mermaid diagrams#15
brunojppb merged 3 commits intomainfrom
docs

Conversation

@brunojppb
Copy link
Owner

Summary

  • Complete rewrite of README.md with comprehensive project documentation
  • Added professional project description emphasizing security benefits
  • Created detailed Mermaid diagrams showing system architecture and workflows
  • Enhanced user experience with clear quick start guides and usage examples

Documentation Improvements

  • Security-focused narrative: Clear explanation of PDF threats and why complete regeneration is superior
  • Architecture overview: Detailed component descriptions and security approach
  • Visual workflows: Mermaid sequence and flowchart diagrams showing request/response flows
  • API documentation: Complete callback system documentation with request/response formats
  • Development guide: Testing, configuration, and Docker deployment instructions

Mermaid Diagrams Added

  • Request Flow Sequence Diagram: Shows complete client → server → worker → callback flow
  • Background Worker Processing: Flowchart detailing PDF processing pipeline and error handling
  • Process isolation and callback system visualization

Key Features

  • Professional presentation with consistent emoji usage for navigation
  • Accurate technical details reflecting actual implementation
  • Clear code examples for both CLI and web server usage
  • Comprehensive troubleshooting and development information

The documentation now tells a complete story about Sanitisium as a professional security tool, making it accessible for integration and contribution.

🤖 Generated with Claude Code

@brunojppb brunojppb merged commit 9918e24 into main Jul 30, 2025
2 checks passed
@brunojppb brunojppb deleted the docs branch July 30, 2025 19:38
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.

1 participant