Docs: rewrite user-guide to remove first-person pronouns

[leynos]

Summary

• Rewrites sections of the user guide to remove first-person pronouns and adopt a neutral, instructional tone.
• Improves consistency in phrasing around deterministic tests and serializer guidance.

Changes

• Documentation: Updated docs/users-guide.md to replace first-person phrasing with neutral, instructional language.

  • Reworded guidance about duplex capacities to use passive phrasing: from relying on the app to hit back-pressure quickly to assuring that small duplex capacities are used with reader pacing when outbound writes must hit back-pressure quickly.
  • Reworded serializer guidance to remove imperative you language and clarify the recommendation:
    • from: "using dyn Serializer directly is unsupported unless you provide concrete wrappers. For migration, keep concrete serializer types in EncodeWith / DecodeWith bounds, retain ... for legacy ... and use SerdeMessage with SerdeSerializerBridge"
    • to: "using dyn Serializer directly is unsupported unless concrete wrappers are provided. For migration, keep concrete serializer types in EncodeWith / DecodeWith bounds, retain
      wireframe::serializer::MessageCompatibilitySerializer for legacy
      Message-based payloads, and use SerdeMessage with SerdeSerializerBridge."

• No code changes; this is a documentation-only update.

Testing plan

• Build and review updated docs to ensure no first-person pronouns remain in touched sections.
• Confirm the changes render correctly in the repository documentation site.

Rationale

• Aligns the documentation with a neutral, instructional voice and avoids first-person pronouns for consistency across the project docs.

◳ Generated by DevBoxer ◰

---

ℹ️ Tag @devboxerhub to ask questions and address PR feedback

📎 Task: https://www.devboxer.com/task/7601fb7c-3f51-4058-80cd-1f5c76f21845

Summary by Sourcery

Documentation:

• Rewrite user-guide sections to replace second-person, imperative phrasing with neutral instructional language for deterministic test helpers and serializer guidance.

[sourcery-ai]

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Documentation-only PR that rewrites portions of the user guide to remove second/first-person phrasing, adopt a neutral instructional tone, and slightly clarify guidance around deterministic test helpers and serializer usage.

File-Level Changes

Change	Details	Files
Neutralize and clarify wording for deterministic test helper guidance.	Rephrased description of slow-I/O helpers to avoid imperative 'use' phrasing and first/second-person language. Clarified that small duplex capacities should be combined with reader pacing in scenarios where outbound writes must reach back-pressure quickly.	docs/users-guide.md
Clarify serializer object-safety and migration guidance while removing second-person language.	Reworded note about Serializer not being object-safe to avoid addressing the reader directly. Adjusted text about unsupported dyn Serializer usage to refer to concrete wrappers being provided, rather than provided by 'you'. Retained and slightly reflowed the migration recommendation, emphasizing keeping concrete serializer types in EncodeWith/DecodeWith, using MessageCompatibilitySerializer for legacy payloads, and SerdeMessage with SerdeSerializerBridge for new usage.	docs/users-guide.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 9c8e6b85-4db5-476f-bc2c-89485a7ce452

📥 Commits

Reviewing files that changed from the base of the PR and between 8476be5 and cb3376b.

📒 Files selected for processing (1)

• docs/users-guide.md

---

Summary by CodeRabbit

Documentation

• Enhanced user guide documentation with improved readability in the slow-I/O helpers section through refined wording and phrasing. Clarified guidance on deterministic test execution, backpressure handling, and related testing mechanisms.
• Consolidated and tightened phrasing throughout the migration guidance section for improved clarity and consistency in technical documentation.

Walkthrough

Documentation improvements to the users guide, including reworded guidance on slow-I/O helpers for enhanced clarity and capitalisation consistency, and consolidated language in the migration section regarding object safety and concrete serialiser types. No API changes.

Changes

Cohort / File(s)	Summary
Documentation clarity updates docs/users-guide.md	Revised slow-I/O helpers section for readability; consolidated migration guidance on object safety and serialiser types without altering meaning.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

Words polished bright, the guide now gleams,
Small duplex back-pressure dreams,
Serialisers kept concrete and true,
Documentation flows anew! ✨📖

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main purpose of the changeset: rewriting documentation sections to remove first-person pronouns and adopt a neutral tone.
Description check	✅ Passed	The description clearly relates to the changeset, detailing the documentation rewrites, specific phrase changes, testing performed, and the rationale for adopting a neutral instructional voice.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch refactor-docs-remove-first-person-empxr2

📝 Coding Plan

• Generate coding plan for human review comments

---

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

[sourcery-ai]

Hey - I've reviewed your changes and they look great!

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}