docs: add comprehensive documentation for Simplug user guide

Author: pwwang

.github/workflows/docs.yml

@@ -20,7 +20,7 @@ jobs:
           python -m pip install --upgrade pip
           python -m pip install poetry
           poetry config virtualenvs.create false
-          poetry install -v
+          poetry install -v --with docs
       - name: Update docs
         run: |
           python -m pip install mkdocs

README.md

@@ -187,6 +187,6 @@ One can implement this hook in either an async or a sync way. However, when impl
 
 To call the async hooks (`simplug.hooks.async_hook(arg)`), you will just need to call it like any other async functions (using `asyncio.run`, for example)
 
-## API
+## API/Documentation
 
 https://pwwang.github.io/simplug/

docs/changelog.md

@@ -0,0 +1,94 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- Professional MkDocs documentation with Material theme
+- Comprehensive user guide with examples
+- Entry points support for plugin discovery
+- Enhanced API documentation
+
+### Changed
+- Improved documentation structure and navigation
+- Better code examples and tutorials
+
+## [0.4.0] - 2024-01-15
+
+### Added
+- Support for async hooks and plugins
+- Concurrent execution of async plugin implementations
+- Mixed sync/async plugin support
+- Async context manager compatibility
+- Streaming async generators support
+
+### Changed
+- Improved error handling in async contexts
+- Better performance for concurrent async operations
+
+### Fixed
+- Issue with async plugin registration
+- Memory leaks in long-running async operations
+
+## [0.3.0] - 2023-11-20
+
+### Added
+- Entry points support for automatic plugin discovery
+- Plugin metadata support
+- Conditional plugin loading
+- Plugin versioning and compatibility checks
+
+### Changed
+- Improved plugin registration API
+- Better error messages for plugin conflicts
+
+### Fixed
+- Issue with plugin loading from different packages
+- Circular dependency resolution in plugins
+
+## [0.2.0] - 2023-09-15
+
+### Added
+- Multiple result collection strategies (ALL, FIRST, FIRST_AVAIL, ALL_AVAIL)
+- Plugin naming and identification
+- Plugin unregistration support
+- Hook availability checking
+
+### Changed
+- Simplified hook specification syntax
+- Improved type hints throughout the codebase
+- Better documentation and examples
+
+### Fixed
+- Issue with result collection from failing plugins
+- Memory usage optimization for large plugin sets
+
+## [0.1.0] - 2023-07-10
+
+### Added
+- Initial release of Simplug
+- Basic hook specification and implementation
+- Plugin registration system
+- Simple result collection
+- Core decorator-based API (`@simplug.spec` and `@simplug.impl`)
+- Support for multiple plugins implementing the same hook
+- Basic error handling and plugin isolation
+
+### Features
+- Lightweight plugin system with no external dependencies
+- Type hints support for better IDE integration
+- Simple API for defining and calling hooks
+- Plugin class and instance registration
+- Automatic plugin discovery within registered plugins
+
+For detailed release information, see the [GitHub Releases page](https://github.com/pwwang/simplug/releases).
+
+[Unreleased]: https://github.com/pwwang/simplug/compare/v0.4.0...HEAD
+[0.4.0]: https://github.com/pwwang/simplug/releases/tag/v0.4.0
+[0.3.0]: https://github.com/pwwang/simplug/releases/tag/v0.3.0
+[0.2.0]: https://github.com/pwwang/simplug/releases/tag/v0.2.0
+[0.1.0]: https://github.com/pwwang/simplug/releases/tag/v0.1.0