feat(docs): Comprehensive documentation expansion and FastStream integration #37
Conversation
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
- Updated mkdocs.yml to improve navigation structure by grouping related guides and adding new sections for configuration, advanced usage, FastStream integration, examples, API reference, troubleshooting, and release notes. - Revised README.md to clarify framework features, installation instructions, and quick start guide, including a new example for executing workflows. - Expanded creating_application.md to provide a comprehensive guide on application structure, BoostApp initialization, defining activities and workflows, and adding workers. - Enhanced running_application.md to cover development and production deployment strategies, including Docker and Kubernetes setups, process management, and monitoring. - Improved example applications to demonstrate various features of Temporal-boost, including FastStream integration and custom worker configurations. This commit aims to provide clearer guidance for users and improve the overall documentation experience.
- Added .cursor/ to .gitignore to exclude cursor-related files from version control. - Deleted the obsolete .cursor/worktrees.json file as it is no longer needed. This commit helps streamline the project by ensuring unnecessary files are ignored and removed.
- Updated `pyproject.toml` to ignore additional linting rules for mutable default arguments and docstring presence. - Modified per-file ignores for examples and tests to include new linting rules. - Cleaned up whitespace and improved code formatting in `example_app.py`, `example_client.py`, `example_cron.py`, and other example files for better readability. These changes aim to improve code quality and maintainability while ensuring compliance with updated linting standards.
…loyment - Enhanced the CI configuration by adding separate linting jobs for code and examples, utilizing Ruff for linting and formatting checks. - Updated the documentation deployment workflow to include caching of Poetry dependencies and improved steps for building and deploying documentation to GitHub Pages. - Upgraded action versions for better performance and reliability. These changes aim to streamline the CI process, improve code quality checks, and ensure efficient documentation deployment.
- Changed actions in CI workflows to use specific commit SHA versions for better stability and predictability. - Updated `actions/checkout`, `actions/setup-python`, `snok/install-poetry`, `actions/cache`, `codecov/codecov-action`, and `actions/upload-artifact` to their respective commit SHA references. - Added a step to add Poetry to the PATH in multiple workflows to ensure it is accessible during the build process. These changes aim to enhance the reliability of the CI/CD pipeline and ensure consistent behavior across different runs.
- Updated the CI workflows to set `virtualenvs-create` to true for the Poetry installation step, allowing for isolated environments during dependency management. - This change aims to improve dependency handling and ensure a cleaner build process across multiple workflows.
- Added the Poetry binary path to the environment in multiple steps to ensure accessibility during the CI process. - Implemented a verification step for the Poetry installation to confirm successful setup. - Modified dependency installation and test execution commands to dynamically reference the Poetry binary, improving robustness in different environments. These changes aim to streamline the CI workflow and ensure consistent behavior across different runs.
- Updated CI workflow to dynamically reference the Poetry binary, improving compatibility across environments. - Modified commands for installing dependencies, checking imports, and verifying example syntax to ensure consistent execution. - Added environment variable settings to streamline the execution context for Poetry. These changes aim to enhance the robustness and reliability of the CI process.
- Modified the Poetry installation command in the CI workflow to include the `--all-extras` flag, ensuring all optional dependencies are installed. - This change enhances the environment setup for testing and development, providing a more comprehensive dependency management approach.
- Enhanced the CI workflow to dynamically reference the Poetry binary from the GitHub workspace, ensuring compatibility across different environments. - Updated the PATH variable to include the workspace, facilitating access to the Poetry installation. - Added checks to verify the existence of the Poetry binary in multiple locations, improving robustness during dependency installation and test execution. These changes aim to streamline the CI process and enhance reliability in various environments.
- Updated the CI workflow to ensure Poetry is available by adding a check for its installation and installing it if not found. - Simplified the commands for installing dependencies and running tests by directly using the Poetry command, enhancing readability and maintainability. - Improved the PATH variable management to ensure consistent access to the Poetry binary across different steps. These changes aim to streamline the CI process and enhance the reliability of the environment setup.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
feat(docs): Comprehensive documentation expansion and FastStream integration
This PR significantly expands and improves the Temporal-boost documentation for GitHub Pages, adds comprehensive FastStream integration examples and documentation, and enhances the overall developer experience.
📚 Documentation Additions
New Documentation Files
docs/configuration.md- Complete configuration referencedocs/examples.md- Comprehensive examples guidedocs/advanced_usage.md- Advanced patterns and customizationdocs/api_reference.md- Complete API documentationdocs/troubleshooting.md- Common issues and solutionsdocs/faststream_integration.md- FastStream integration guideEnhanced Documentation Files
docs/index.md- Improved getting started guidedocs/creating_application.md- Expanded application creation guidedocs/running_application.md- Production deployment guideREADME.md- Modernized project README💡 Example Enhancements
New Examples
examples/example_starter.py- Enhanced starter example with better documentationexamples/example_cron.py- CRON worker exampleexamples/example_signals.py- Workflow signals exampleexamples/example_ecommerce.py- E-commerce order processingexamples/example_fastapi.py- FastAPI integrationexamples/example_parallel.py- Parallel activities executionexamples/example_error_handling.py- Error handling patternsexamples/example_client.py- Workflow client examplesexamples/example_faststream_temporal.py- FastStream with Temporal workflowsexamples/example_faststream_advanced.py- Advanced FastStream patternsexamples/example_faststream_producer.py- Message producer for testingEnhanced Examples
examples/example_app.py- Comprehensive example with better documentationexamples/example_simple_faststream.py- Improved with documentation and commentsDocumentation
examples/README.md- Comprehensive examples guide🔧 Configuration Updates
mkdocs.yml- Updated navigation structure✨ Key Features
FastStream Integration
Documentation Improvements
Developer Experience
📋 Documentation Structure
🎯 Benefits
📝 Testing
All examples have been tested and include:
🔗 Related
Breaking Changes: None
Migration Guide: Not applicable - documentation-only changes
Checklist: