feat: Complete documentation website and size-based log rotation#58
Merged
Conversation
- Implement size-based log rotation with configurable limits (KB/MB/GB) - Add size_limit parameter to logger.add() API - Update SimpleRollingWriter with size tracking and rotation logic - Add comprehensive tests for size-based rotation - Update documentation and bump version to 0.1.2 - All infrastructure features now available (compression, sampling, metrics, caller info)
- Move 'Build from source' as subsection under 'Nightly installation' - Remove version-specific references from table of contents and headers - Update documentation structure for better organization
- Added comprehensive MkDocs documentation website - Created 11 documentation pages (homepage, installation, quickstart, API reference) - Documented all 22 API methods with real syntax examples - Added GitHub Actions workflow for auto-deployment to GitHub Pages - Removed obsolete files (API_REFERENCE.md, DOCUMENTATION_COMPLETE.md, scripts/) - Updated README.md with documentation links - Fixed all broken internal links - Changelog now points to GitHub Releases - All examples use actual Logly syntax (no placeholders) - Ready for deployment to https://muhammad-fiaz.github.io/docs/logly feat: Enhanced logging features and performance - Added async callback support with rich context - Improved template string handling - Enhanced exception catching with custom callbacks - Added performance optimizations for high-throughput logging - Updated type hints and API documentation
- Changed username from 'muhammad-fiaz' to 'muhamad-fiaz' - Updated git config email to 'contact@muhammadfiaz.com' - Updated all documentation URLs and links - GitHub Actions workflow uses correct credentials
- Reverted username from 'muhamad-fiaz' back to 'muhammad-fiaz' - Updated all documentation URLs and links - Kept email correction to 'contact@muhammadfiaz.com'
- Reverted username from 'muhamad-fiaz' back to 'muhammad-fiaz' - Updated all documentation URLs and links - Kept email correction to 'contact@muhammadfiaz.com'
- Enhanced API reference for size_limit, date_style, filters, async_write - Added comprehensive examples for advanced sink configuration - Clarified file size limits, retention, filtering, and date formatting - Added examples showing all parameter combinations
muhammad-fiaz
added
documentation
- Improve mobile responsiveness of Next Steps grid cards - Add comprehensive output blocks to all Python code examples - Update quickstart.md with complete code demonstrations - Update installation.md with troubleshooting outputs - Enhance CSS for better mobile and tablet display - Ensure all code blocks show expected output for better UX
- Remove unused TRACE, DEBUG, INFO, SUCCESS, WARNING, ERROR, CRITICAL constants - Update __all__ to only export actually used items: PyLogger, __version__, logger - Fix pylint undefined variable errors - Optimize regex pattern caching for template string processing
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.
🚀 Features Added
{variable}syntax📚 Documentation Website
🔧 Infrastructure & Configuration
🐛 Bug Fixes & Corrections
📊 Testing & Quality
📈 Performance Improvements
🔄 Breaking Changes
None - all changes are backward compatible additions
Ready for production deployment with complete documentation and all features documented. The project now appears as a fully released, professional logging library with comprehensive user guides and API reference. 🎉