Align docs to en-GB-oxendict spelling; add migration guide

[leynos]

Summary

• Align docs to en-GB-oxendict spelling in documentation
• Add a migration guide for the configuration naming change from normalised to normalized

Changes

Documentation

• docs/server/configuration.md
  • Update the explanatory sentence to reflect the configuration BackoffConfig naming, using BackoffConfig::normalized where appropriate
• docs/v0-1-0-to-v0-2-0-migration-guide.md
  • New migration guide documenting the BackoffConfig naming update from normalised to normalized and its impact on existing code and docs

Rationale

• These changes align documentation with en-GB-oxendict conventions while providing upgrade guidance for the configuration naming.

Validation

• Manually review the changed docs to confirm updated spelling and formatting
• Build or preview docs to ensure formatting remains valid and readable

📎 Task: https://www.devboxer.com/task/e565625c-d896-4ae5-9eb3-d89436e26337

Closes #313

[coderabbitai]

Summary by CodeRabbit

• Documentation
  • Standardised spelling conventions across server configuration docs for consistency and clarity.
  • Updated the migration guide and examples to reflect renamed API references so examples and guidance match current public interfaces.

Walkthrough

Update to documentation: docs/server/configuration.md changes prose from "normalises" to "normalizes". docs/v0-1-0-to-v0-2-0-migration-guide.md updates API reference and examples to rename BackoffConfig.normalised → BackoffConfig.normalized. No behavioural code changes.

Changes

Cohort / File(s)	Summary
Server configuration prose docs/server/configuration.md	Replace prose "normalises" with "normalizes" (spelling change only).
Migration guide / API reference docs/v0-1-0-to-v0-2-0-migration-guide.md	Rename public API reference and examples from BackoffConfig.normalised(...) to BackoffConfig.normalized(...); update usages in guide.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

✨ A tiny edit, letters aligned,
-ise to -ize, the docs refined,
A guide updated, names set straight,
Consistency now checks the gate. 📝

🚥 Pre-merge checks | ✅ 1 | ❌ 4

❌ Failed checks (4 warnings)

Check name	Status	Explanation	Resolution
Title check	⚠️ Warning	The title references alignment to en-GB-oxendict spelling and migration guide addition, but the actual changes include unauthorised renaming of the BackoffConfig method from normalised to normalized, which contradicts the linked issue requirements.	Revise the title to accurately reflect the actual changes. The PR introduces breaking API changes beyond the scope of issue #313, which only requested documentation prose updates without method renaming.
Description check	⚠️ Warning	The description claims to align docs with en-GB-oxendict spelling and add a migration guide, but misrepresents the scope by presenting the method rename as an intentional change when issue #313 explicitly stated the method name should remain unchanged.	Clarify whether the API method rename was intentional or scope creep. If unintentional, revert the rename to BackoffConfig::normalised and remove the migration guide. If intentional, acknowledge this as a breaking change outside the original issue scope.
Linked Issues check	⚠️ Warning	The PR does not meet the requirements of issue #313. Whilst the documentation prose was updated from normalises to normalizes as required, the PR additionally renamed the public API method from BackoffConfig::normalised to BackoffConfig::normalized—a breaking change explicitly prohibited by the issue.	Revert the API method name from BackoffConfig::normalized back to BackoffConfig::normalised. Keep only the documentation prose changes (normalises → normalizes) as specified in issue #313. Remove the migration guide file.
Out of Scope Changes check	⚠️ Warning	The PR contains significant out-of-scope changes: renaming the public API method BackoffConfig from normalised to normalized and adding a migration guide. Issue #313 explicitly stated only the documentation prose should be updated, not the method name.	Remove the method rename and migration guide changes. Restrict modifications to documentation prose only, updating normalises to normalizes in docs/server/configuration.md as originally specified in issue #313.

✅ Passed checks (1 passed)

Check name	Status	Explanation
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 fix-spelling-docs-server-config-bkkh22

---

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

[sourcery-ai]

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Aligns two documentation pages with en-GB-oxendict conventions and improves readability by reflowing a mitigation note and adjusting spelling around backoff configuration.

File-Level Changes

Change	Details	Files
Reflow a mitigation note in the Cucumber-to-rstest-bdd migration guide for better readability without altering meaning.	Split a long mitigation sentence into two lines to improve line wrapping around the scenarios! macro mention Kept the wording and semantics of the mitigation guidance unchanged	docs/execplans/migrate-from-cucumber-to-rstest-bdd.md
Adjust spelling in server configuration docs to match the chosen English variant while keeping technical details intact.	Update the narrative text to use the preferred spelling for "normalizes" while leaving the referenced BackoffConfig::normalised API name unchanged Ensure the surrounding explanation of exponential backoff and configuration clamping remains identical aside from spelling	docs/server/configuration.md

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#313	Update the prose in docs/server/configuration.md to use en-GB-oxendict -ize spelling by changing the phrase 'builder normalises the supplied configuration via' to 'builder normalizes the supplied configuration via'.	✅
#313	Ensure the method name BackoffConfig::normalised in docs/server/configuration.md remains unchanged while updating the surrounding prose.	✅

Possibly linked issues

• Fix spelling consistency: use -ize instead of -ise in documentation prose #313: They both update the same configuration.md sentence from “normalises” to “normalizes,” matching the requested spelling change.

---

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.

[sourcery-ai]

Hey - I've left some high level feedback:

• The configuration docs now mix en-US (“normalizes”) with en-GB (“normalised” in the function name); consider using consistent en-GB wording in the prose or explicitly clarifying the divergence if the function name must stay as-is.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- The configuration docs now mix en-US (“normalizes”) with en-GB (“normalised” in the function name); consider using consistent en-GB wording in the prose or explicitly clarifying the divergence if the function name must stay as-is.

---

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.}

[leynos]

@coderabbitai Please raise a GitHub defect to correct the spelling of the method name (BackoffConfig::normalised -> BackoffConfig::normalized) including update of relevant tests and documentation and release as a breaking 0.x point release

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Find the BackoffConfig::normalised method definition and usages
echo "=== Finding BackoffConfig definition and normalised method ==="
rg -n "BackoffConfig" --type rust -C 3

echo ""
echo "=== Finding usages of 'normalised' method ==="
rg -n "normalised" --type rust -C 2

Length of output: 16733

---

🏁 Script executed:

#!/bin/bash
# Create GitHub issue for renaming the method
gh issue create \
  --title "Rename BackoffConfig::normalised to BackoffConfig::normalized" \
  --body "## Description

Rename the method \`BackoffConfig::normalised\` to \`BackoffConfig::normalized\` to align with American English spelling conventions for this API.

## Required Changes

- Rename method definition in \`src/server/runtime/backoff.rs\` (line 57)
- Update method call in \`src/server/runtime.rs\` (line 338)
- Update documentation references in \`src/server/config/mod.rs\` (lines 142, 146, 152)
- Update any relevant tests that reference the method name
- Update documentation that mentions the method

## Breaking Change

This is a breaking API change and should be released as part of a 0.x point release.

## Related

- PR: https://github.com/leynos/wireframe/pull/440
- Requested by: `@leynos` in https://github.com/leynos/wireframe/pull/440#discussion_r" \
  --assignee "leynos"

Length of output: 46

---

@leynos: I've created GitHub issue #441 to address the method name correction.

The issue includes:

• Renaming BackoffConfig::normalised → BackoffConfig::normalized
• Updating the method definition in src/server/runtime/backoff.rs
• Updating the call site in src/server/runtime.rs
• Updating documentation references in src/server/config/mod.rs
• Updating relevant tests
• Marking it as a breaking change for a 0.x point release

The issue has been assigned to you and includes a backlink to this PR.

🔗 #441