chore: add fork diff explanation

[yordis]

No description provided.

[coderabbitai]

Walkthrough

Two documentation files are modified: README.md receives a new editorial note linking to fork differences documentation, and a new comprehensive guide documenting differences between the straw-hat-team/commanded fork and upstream commanded/commanded is created, detailing breaking changes and new features.

Changes

Cohort / File(s)	Summary
Documentation Updates README.md	Adds editorial note at end of file linking to fork differences guide.
New Fork Differences Guide guides/explanations/fork-differences.md	New documentation file comprehensively documenting fork differences including breaking changes (ProcessManager removal), new features (EnrichedMetadata, UUIDv7 support, configurable UUID provider, aggregate telemetry, custom event ID support, built-in EventStore adapter), and changes to event handling callbacks and metadata representation.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

• Documentation-only changes with no code logic
• Straightforward additions and references
• No functional implementation or structural changes to review

Poem

🐰 A fork well-documented, clear and bright,
With differences laid bare for all to sight,
From ProcessManager's fade to UUID's gleam,
These docs unite the fork and upstream dream,
Hop along, dear readers, knowledge takes flight! 📚✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.
Description Check	❓ Inconclusive	No pull request description was provided by the author. While the check is designed to be lenient and pass as long as the description is not completely off-topic, an empty or missing description does not satisfy the criterion of being "related in some way to the changeset." The description neither explicitly relates to the changes nor makes any claims that are off-topic, creating ambiguity about which evaluation category applies. This falls under insufficient information to determine a clear pass or fail outcome.	Consider adding a brief pull request description explaining the purpose of adding fork difference documentation. Even a short summary such as "This PR documents the key differences between the straw-hat-team/commanded fork and the upstream commanded/commanded repository to help contributors understand the fork's modifications and enhancements" would provide valuable context for reviewers and future maintainers.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The pull request title "chore: add fork diff explanation" directly and accurately describes the main change in the changeset. The PR adds documentation explaining differences between the fork and upstream, with additions to README.md (an editorial note linking to the new guide) and a new comprehensive guide file at guides/explanations/fork-differences.md. The title is concise, clear, and avoids vague terminology or noise, effectively communicating the primary purpose of the changes.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch yordis/chore-1

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

guides/explanations/fork-differences.md (2)

14-37: Emoji inconsistency for breaking changes—consider standardizing the visual hierarchy.

The "Removed ProcessManager Support" entry uses ❌ while "EnrichedMetadata Struct" uses 🔄. Since both are breaking changes, using consistent iconography (e.g., ❌ for both or a consistent breaking change indicator) would improve visual scannability.

Additionally, EnrichedMetadata lacks a "Reason:" explanation like ProcessManager has. Consider adding context for why this structural change was introduced, not just what changed.

---

1-85: Comprehensive and well-structured documentation of fork changes.

The document effectively documents breaking changes and new features with clear formatting, descriptive change summaries, and repository links. It aligns well with the Diataxis framework referenced in the README. The hierarchical structure (Overview → Breaking Changes → Features) makes it easy for users to navigate and understand the fork's divergence from upstream.

Minor suggestion: Consider adding a migration/upgrade guidance section for breaking changes (ProcessManager removal, EnrichedMetadata struct) so users know how to adapt their code when upgrading. This could be a separate "Migration Guide" section or linked docs.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fbe7479 and e09469d.

📒 Files selected for processing (2)

• README.md (1 hunks)
• guides/explanations/fork-differences.md (1 hunks)

🔇 Additional comments (2)

README.md (1)

36-37: Editorial note placement and linking is appropriate.

The reference to fork differences documentation is well-positioned after the attribution section and uses clear, descriptive link text. The file path correctly points to the new guide being added.

guides/explanations/fork-differences.md (1)

51-57: Missing PR reference for Configurable UUID Provider.

All other features include PR links for traceability, but "Configurable UUID Provider" (lines 51–57) omits this reference. For consistency and discoverability, include the PR link if available.

Could you add the PR reference for this feature if one exists?

[Copilot]

Pull Request Overview

This PR adds comprehensive documentation for the fork differences between straw-hat-team/commanded and the upstream commanded/commanded repository.

• Created a new documentation file that tracks breaking changes and new features in the fork
• Added a reference link from the README to the new fork differences documentation
• Provides clear visibility into the fork's independent release cycle and feature additions

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File	Description
guides/explanations/fork-differences.md	New documentation file detailing all breaking changes (ProcessManager removal, EnrichedMetadata struct) and new features (UUIDv7, configurable UUID provider, telemetry, custom event IDs, EventStore adapter)
README.md	Added link to the fork differences documentation in the Attribution section

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.