Skip to content

Feature/refactor docs#46

Merged
reiase merged 9 commits intomainfrom
feature/refactor_docs
Jan 24, 2026
Merged

Feature/refactor docs#46
reiase merged 9 commits intomainfrom
feature/refactor_docs

Conversation

@reiase
Copy link
Contributor

@reiase reiase commented Jan 24, 2026

Overview:

Details:

Where should the reviewer start?

Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)

  • closes GitHub issue: #xxx

…tructure and remove deprecated features

- Updated README files to clarify the usage of the `pulsing actor` command, now requiring full class paths for actor types.
- Enhanced documentation for starting actors, including examples for the new Router and worker classes.
- Removed references to the deprecated `pulsing actor list` command, replacing it with `pulsing inspect` for actor system observation.
- Updated various examples and guides to align with the new command structure and improve user understanding.
…onality

- Introduced `pulsing_pingpong.py` demonstrating a simple ping-pong interaction using the @Remote decorator.
- Added `pulsing_research.py` showcasing a multi-agent research workflow with Researcher, Analyst, and Reporter agents.
- Created `chaos_proof.py` to illustrate actor resilience with automatic restarts on failure, simulating task completion despite crashes.
- Implemented `function_to_fleet.py` to demonstrate scaling functions into a fleet of workers for improved throughput.
- Updated README with new examples and usage instructions for enhanced clarity and user guidance.
- Added new sections to the API documentation, including an overview of core concepts and detailed usage patterns for the Pulsing framework.
- Updated existing examples to reflect recent changes in actor spawning and resolution methods, ensuring clarity and usability.
- Improved documentation for the `@pul.remote` decorator and actor lifecycle management, providing clearer guidance for users.
- Introduced new API reference files for both Python and Rust, enhancing accessibility and understanding of the framework's capabilities.
- Refactored various documentation files to improve consistency and readability across the codebase.
…g framework

- Revised descriptions in `README.md`, `README.zh.md`, and `llms.binding.md` to emphasize Pulsing as a distributed actor framework with specialized support for AI applications.
- Improved site description in `mkdocs.yml` for better alignment with the framework's capabilities.
- Added a comprehensive FAQ section in `faq.md` and its Chinese counterpart `faq.zh.md`, addressing common user questions and installation issues.
- Enhanced navigation structure in `mkdocs.yml` for better accessibility to documentation resources.
- Updated API overview documentation to reflect recent changes and improve user understanding of the framework's functionalities.
…earch workflow

- Deleted `pulsing_pingpong.py` and `pulsing_research.py` files, which demonstrated basic actor interactions and multi-agent workflows using the @Remote and @agent decorators, respectively. This cleanup aligns with recent refactoring and updates to the framework.
- Added a newline at the end of the FAQ sections in both English and Chinese versions of the document to adhere to markdown standards and improve readability.
@codecov-commenter
Copy link

codecov-commenter commented Jan 24, 2026

Codecov Report

❌ Patch coverage is 79.09655% with 236 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
crates/pulsing-actor/src/system/resolve.rs 64.21% 73 Missing ⚠️
crates/pulsing-actor/src/error.rs 63.69% 53 Missing ⚠️
crates/pulsing-actor/src/system/config.rs 69.51% 50 Missing ⚠️
crates/pulsing-actor/src/system/load_balancer.rs 86.76% 18 Missing ⚠️
crates/pulsing-actor/src/system/lifecycle.rs 88.40% 16 Missing ⚠️
crates/pulsing-actor/src/test_helper.rs 86.66% 16 Missing ⚠️
crates/pulsing-actor/src/system/spawn.rs 97.17% 5 Missing ⚠️
crates/pulsing-actor/src/system/mod.rs 71.42% 4 Missing ⚠️
python/pulsing/topic/broker.py 85.71% 1 Missing ⚠️
Files with missing lines Coverage Δ
crates/pulsing-actor/src/actor/address.rs 82.91% <100.00%> (ø)
crates/pulsing-actor/src/actor/context.rs 87.27% <ø> (ø)
crates/pulsing-actor/src/actor/mailbox.rs 89.01% <ø> (ø)
crates/pulsing-actor/src/actor/reference.rs 46.58% <ø> (ø)
crates/pulsing-actor/src/actor/traits.rs 83.80% <ø> (ø)
crates/pulsing-actor/src/behavior/context.rs 27.58% <ø> (ø)
crates/pulsing-actor/src/behavior/core.rs 51.89% <ø> (ø)
crates/pulsing-actor/src/behavior/reference.rs 10.60% <ø> (ø)
...rates/pulsing-actor/src/cluster/backends/gossip.rs 76.66% <ø> (ø)
crates/pulsing-actor/src/cluster/backends/head.rs 70.15% <ø> (ø)
... and 24 more

... and 28 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

… installation

- Added cargo-binstall action to streamline the installation of Rust tools.
- Updated installation command for cargo-nextest to use cargo binstall for improved security and efficiency.
…ld-env action to default to latest version, streamlining the installation process.
@reiase reiase merged commit 30c02e8 into main Jan 24, 2026
13 checks passed
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.

2 participants

Comments