Skip to content

Fix spelling errors and update broken links in documentation.#3109

Merged
MrHinsh merged 1 commit intonkdAgility:mainfrom
kimkdk:fix-documentation-spellings-and-broken-links
Mar 2, 2026
Merged

Fix spelling errors and update broken links in documentation.#3109
MrHinsh merged 1 commit intonkdAgility:mainfrom
kimkdk:fix-documentation-spellings-and-broken-links

Conversation

@kimkdk
Copy link
Copy Markdown
Contributor

@kimkdk kimkdk commented Feb 13, 2026

Fix minor typos and repair a couple of broken links in documentation.

Summary by CodeRabbit

Release Notes

  • Documentation
    • Corrected spelling, grammar, and terminology across documentation files and instructions.
    • Fixed terminology consistency, including "Suites" vs "Suits" and "Azure DevOps" naming.
    • Improved documentation link references for better consistency and maintainability.
    • Enhanced readability with minor formatting and wording refinements throughout guides.

@kimkdk kimkdk requested a review from MrHinsh as a code owner February 13, 2026 12:55
@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Feb 13, 2026

CLA assistant check
All committers have signed the CLA.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Feb 13, 2026

Walkthrough

This pull request corrects numerous spelling, grammar, and terminology issues across documentation and configuration files, alongside formatting improvements and link reference updates to Hugo shortcodes for better maintainability.

Changes

Cohort / File(s) Summary
Spelling & Terminology Corrections
README.md, docs/content/docs/get-started/getting-started/index.md, docs/content/docs/get-started/version-control/index.md, docs/content/docs/how-to/user-mappings/index.md, docs/content/docs/reference/field-maps/_index.md, docs/content/docs/reference/processors/tfs-workitem-delete-processor/index.md, docs/content/docs/reference/tools/tfsnodestructuretool/index.md, docs/content/docs/setup/installation/index.md, .github/instructions/src.instructions.md
Fixed spelling errors: "omment" → "comment", "Suits" → "Suites", "OpenTelemetery" → "OpenTelemetry", "analyse" → "analyze", "diferent" → "different", "depreciated" → "deprecated", "Prerequisits" → "Prerequisites", "prefered" → "preferred", "usied" → "used", "fieldmaps" → "field maps", "extream" → "extreme", "quereis" → "queries", "dont" → "don't", "unzop" → "unzip".
Documentation Link Reference Updates
docs/content/docs/reference/processors/tfs-workitem-migration-processor/index.md, docs/content/docs/setup/reflected-workitem-id/index.md
Replaced relative file paths with Hugo doc reference shortcodes (e.g., {{< ref "docs/reference/field-maps" >}}) for improved link resolution and maintainability.
Front Matter & Title Corrections
docs/content/docs/config/config-wizard/index.md, docs/content/docs/reference/processors/tfs-test-plans-and-suites-migration-processor/index.md
Fixed spacing and terminology in page titles and descriptions: "Azur eDevOps" → "Azure DevOps", "Suits" → "Suites".
README & Extension Documentation
README.md, src/MigrationTools.Extension/README.md
Corrected terminology ("Suits" → "Suites"), updated tooling lists, fixed formatting (semicolon → colon), and refined phrasing for consistency.
Minor Formatting Adjustments
docs/content/docs/how-to/user-mappings/index.md
Added proper spacing after Markdown heading markers (e.g., "##How" → "## How") and refined wording ("greater" → "better").

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Suggested reviewers

  • MrHinsh
  • ovebastiansen

Poem

✨ A garden of typos laid to rest,
Where "Suits" became "Suites" at last blessed,
With links that now speak Hugo's tongue,
And spacing where careless dashes were hung—
Polish without friction, precision with grace. 🎯

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarises the main purpose of the changeset: fixing spelling errors and updating broken links across documentation files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Merge Conflict Detection ✅ Passed ✅ No merge conflicts detected when merging into main

✏️ 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

Tip

Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord.


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

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

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@docs/content/docs/reference/tools/tfsnodestructuretool/index.md`:
- Line 188: The sentence describing PrefixProjectToNodes is missing a comma
after the word "nodes" for readability; in the sentence that mentions "This was
super valuable when the target Project already has nodes and you don't want to
merge them all together," insert a comma after "nodes" so it reads "...already
has nodes, and you don't want to merge..." and keep the references to
PrefixProjectToNodes, Areas.Mappings, and Iterations.Mappings unchanged.
🧹 Nitpick comments (6)
docs/content/docs/how-to/user-mappings/index.md (1)

46-46: Optional: Consider tightening the prose.

While you're tidying up, "all the Users" reads more concisely than "all of the Users". Not critical, but it's sitting there if you fancy polishing it further.

✍️ Proposed refinement
-1. Run `TfsExportUsersForMappingProcessor` which will export all of the Users in Source mapped or not to target.
+1. Run `TfsExportUsersForMappingProcessor` which will export all the Users in Source mapped or not to target.
docs/content/docs/setup/installation/index.md (1)

37-37: Typo fix is fine, but the page still violates the required section order.
This file lacks the mandated section sequence (Overview → Configuration Structure → Common Scenarios → Good Practices → Troubleshooting → Schema). Please align the structure to the guideline.

As per coding guidelines: “Documentation files should include sections in order: Overview (with subsections How It Works, Use Cases), Configuration Structure (with subsections Options, Sample, Defaults, Basic Examples, Complex Examples), Common Scenarios, Good Practices, Troubleshooting, and Schema”.

docs/content/docs/config/config-wizard/index.md (1)

2-2: Title fix is fine, but the page structure still breaks the required section order.
Please rework the headings to follow the mandated sequence (Overview → Configuration Structure → Common Scenarios → Good Practices → Troubleshooting → Schema).

As per coding guidelines: “Documentation files should include sections in order: Overview (with subsections How It Works, Use Cases), Configuration Structure (with subsections Options, Sample, Defaults, Basic Examples, Complex Examples), Common Scenarios, Good Practices, Troubleshooting, and Schema”.

docs/content/docs/reference/processors/tfs-test-plans-and-suites-migration-processor/index.md (1)

3-3: Description fix is right, but the page structure still violates the required section order.
Please restructure to the mandated sequence.

As per coding guidelines: “Documentation files should include sections in order: Overview (with subsections How It Works, Use Cases), Configuration Structure (with subsections Options, Sample, Defaults, Basic Examples, Complex Examples), Common Scenarios, Good Practices, Troubleshooting, and Schema”.

docs/content/docs/get-started/version-control/index.md (1)

18-36: Text reads better, but the page still doesn’t follow the required section order.
Restructure to the mandated sequence before we bless this.

As per coding guidelines: “Documentation files should include sections in order: Overview (with subsections How It Works, Use Cases), Configuration Structure (with subsections Options, Sample, Defaults, Basic Examples, Complex Examples), Common Scenarios, Good Practices, Troubleshooting, and Schema”.

docs/content/docs/get-started/getting-started/index.md (1)

3-31: Content updates are fine, but the page structure still violates the required section order.
Please reorganise to the prescribed sequence before release.

As per coding guidelines: “Documentation files should include sections in order: Overview (with subsections How It Works, Use Cases), Configuration Structure (with subsections Options, Sample, Defaults, Basic Examples, Complex Examples), Common Scenarios, Good Practices, Troubleshooting, and Schema”.

@MrHinsh MrHinsh enabled auto-merge March 2, 2026 22:30
@MrHinsh MrHinsh merged commit 34157cf into nkdAgility:main Mar 2, 2026
12 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.

3 participants