Comprehensive Documentation Update for PorQua Repository

[rishavtarway]

Comprehensive Documentation Overhaul for PorQua

Issue Overview

I propose a comprehensive documentation update for the PorQua repository to improve its accessibility and align with other GeomScale projects like volesti.

Proposed Enhancements

README Redesign

• Create a distinctive logo/banner
• Add status badges (Python version, build status)
• Craft a concise description of PorQua's capabilities
• Provide detailed installation guide with dependencies
• Include a "Quick Start" section with examples
• Create a features-to-examples mapping table
• Add theoretical foundation sections on portfolio theory

Code Documentation Standardization

• Implement consistent NumPy-style docstrings
• Complete documentation for all classes and methods
• Add practical examples within docstrings
• Ensure comprehensive type hints

Additional Documentation Resources

• Create a CONTRIBUTING.md guide
• Establish a structured doc/ directory with:
  • Tutorials for common use cases
  • API reference documentation
  • Mathematical foundations
  • Project history and contributors

External Documentation

• Develop GitHub Wiki with tutorials
• Implement ReadTheDocs integration

Addressing Previous Feedback

• Expand installation instructions with dependency management
• Include runnable examples and test procedures
• Clarify the relationship between features and examples
• Explain the theoretical underpinnings of optimization techniques

Implementation Plan

1. Revamp README.md with comprehensive structure
2. Update docstrings in core modules
3. Develop additional documentation files
4. Configure external documentation platforms

[rishavtarway]

I've started working on documentation improvements for PorQua to make it more accessible for users. I'll update the README, improve code documentation, and create additional resources as outlined. I welcome feedback and will submit a PR soon.

[rishavtarway]

@cbachela @TolisChal @vissarion @vfisikop I've started working on documentation improvements for PorQua. Your expertise in portfolio optimization, statistical software, and mathematical algorithms would be invaluable. Any feedback on my documentation plan would be greatly appreciated as I begin implementing these changes.

[rishavtarway]

As someone is already working on this through #15