Fix spelling errors and update broken links in documentation.#3109
Conversation
WalkthroughThis 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
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
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”.
Fix minor typos and repair a couple of broken links in documentation.
Summary by CodeRabbit
Release Notes