Merge branch 'copilot/fix-style-issues-in-docs' of https://github.com/doc-detective/doc-detective.github.io into copilot/fix-style-issues-in-docs

Author: hawkeyexl

.vale.ini

@@ -18,3 +18,7 @@ Google.Headings = warning
 # Google.Quotes requires American punctuation style which can conflict with 
 # code examples and technical terms - relax to warning
 Google.Quotes = warning
+
+# Vale.Spelling doesn't respect vocabulary in frontmatter/titles
+# Relax to warning for technical docs with API terms
+Vale.Spelling = warning

docs/contribute/docs/local-development.mdx

@@ -106,7 +106,7 @@ Use VS Code Dev Containers for a zero-config environment:
    npm run start
    ```
 
-Everything is pre-configured and ready to go!
+Everything is pre-configured and ready to go.
 
 ### Option 2: Local installation
 

docs/contribute/docs/quick-start.mdx

@@ -28,15 +28,15 @@ Every documentation page has an **Edit this page** link at the bottom. This is t
 4. __Preview your changes__: Open a preview panel (Ctrl+Shift+V) to see how it looks.
 5. __Commit your changes__:
    1. In the side panel, click the **Source Control** button (looks like a branch icon).
-   1. Add a brief description of what you changed (e.g., "Fix typo in installation steps").
+   1. Add a brief description of what you changed (for example, "Fix typo in installation steps").
    1. Click "Commit & Push".
 6. __Create a pull request__:
    1. Review the changes one more time.
    1. In the Source Control panel, click the **Create Pull Request** button (looks like a vertical line with dots on both ends with an arrow pointing to the top and a plus sign).
    1. Enter a name and description for the pull request.
    1. Click **Create** to submit.
 
-That's it! A maintainer will review your contribution.
+That's it. A maintainer will review your contribution.
 
 ## Tips for quick contributions
 
@@ -70,7 +70,7 @@ For different issues across different pages, create separate pull requests—it'
    - Build verification
 2. __Review__: A maintainer reviews your changes (usually within 2 business days)
 3. __Feedback__: If changes are needed, the reviewer will comment on your pull request
-4. __Merge__: Once approved, your contribution is merged and goes live!
+4. __Merge__: Once approved, your contribution is merged and goes live.
 
 ## Common contributor concerns (and why you don't need to worry)
 
@@ -80,7 +80,7 @@ For quick fixes like typos and link updates, no testing is required. The automat
 
 ### What if the automated checks fail?
 
-Don't worry! The reviewer will help you fix any issues. Most common failures are easily correctable:
+Don't worry. The reviewer will help you fix any issues. Most common failures are correctable:
 - __Vale failures__: Usually suggest alternative wording (often just suggestions)
 - __Link check failures__: Means a link is broken or inaccessible
 - __Build failures__: Usually means there's a syntax error in Markdown

docs/contribute/docs/review-process.mdx

@@ -50,7 +50,7 @@ In your pull request, you'll see status checks:
 
 ### If checks fail
 
-Don't panic! Failed checks are common and usually easy to fix.
+Don't panic. Failed checks are common and can usually be fixed.
 
 #### Vale failures
 
@@ -279,7 +279,7 @@ Most disagreements resolve through discussion.
 
 ### When your PR is approved
 
-Congratulations! Your contribution will be merged soon.
+Congratulations. Your contribution will be merged soon.
 
 What happens next:
 
@@ -289,11 +289,11 @@ What happens next:
 
 ### After merge
 
-Celebrate! 🎉 You've contributed to open source! Post about it, add to your portfolio, tell your friends.
+Celebrate. 🎉 You've contributed to open source. Post about it, add to your portfolio, tell your friends.
 
 If your PR addresses an issue, it should close automatically.
 
-Found something else to improve? Open another PR!
+Found something else to improve? Open another PR.
 
 ## Special cases
 
@@ -369,7 +369,7 @@ Life happens. If you can't address feedback right away,
 - **Suggest improvements**: Open issues for documentation gaps you notice
 - **Join the community**: Engage in Discord discussions
 
-### You're now a contributor!
+### You're now a contributor
 
 Thank you for making Doc Detective better. Your contribution, no matter how small, helps all of our users.
 

docs/contribute/docs/standard-contributions.mdx

@@ -245,7 +245,7 @@ Before creating a pull request:
 2. **Maintainer reviews** your contribution (within 5 business days)
 3. **Feedback or approval**:
    - If changes are needed, update your pull request.
-   - If approved, your contribution is merged!
+   - If approved, your contribution is merged.
 
 ### Understanding automated checks
 

docs/contribute/docs/templates/feature.mdx

@@ -219,7 +219,7 @@ Examples should be copy-pasteable and work as-is:
 }
 ```
 
-### Document breaking changes clearly
+### Document breaking changes
 
 Be explicit about what breaks:
 
@@ -373,7 +373,7 @@ None. This is a backward-compatible addition. Existing screenshots continue to w
 
 ## Checklist before submitting
 
-- [ ] Clearly explains what the feature is and why it matters
+- [ ] Explains what the feature is and why it matters
 - [ ] Provides complete, working examples
 - [ ] Documents all configuration options
 - [ ] Includes migration guide if replacing existing functionality

docs/contribute/docs/templates/reference.mdx

@@ -164,7 +164,7 @@ Reference docs should cover unusual behavior:
 
 ✅ Complete:
 
-> If `timeout` is set to `0`, the action waits indefinitely. If `timeout` is negative, it defaults to 5000ms.
+> If `timeout` is set to `0`, the action waits indefinitely. If `timeout` is negative, it defaults to 5000 ms.
 
 ⛔ Incomplete:
 

docs/contribute/docs/templates/troubleshooting.mdx

@@ -181,7 +181,7 @@ Help users understand, don't just give commands:
 
 ✅ Educational:
 
-> Increase the timeout to 10000ms (10 seconds) to give the page more time to load. CI environments are often slower than local machines.
+> Increase the timeout to 10000 ms (10 seconds) to give the page more time to load. CI environments are often slower than local machines.
 
 ⛔ Just commands:
 
@@ -368,7 +368,7 @@ If you've tried these solutions and still have issues:
 
 ## Checklist before submitting
 
-- [ ] Problem is clearly stated in the title
+- [ ] Problem is stated in the title
 - [ ] Symptoms are specific and observable
 - [ ] Exact error messages are included
 - [ ] Root cause is explained

docs/contribute/docs/templates/tutorial.mdx

@@ -56,7 +56,7 @@ description: [What users will learn and accomplish]
 
 - Prerequisite knowledge or skill
 - Required tool or software
-- Estimated time (e.g., "30 minutes")
+- Estimated time (for example, "30 minutes")
 
 ## Step 1: [First major concept or action]
 
@@ -148,14 +148,14 @@ Each step should build on previous ones:
 
 ✅ Good progression:
 
-1. Create a simple test with one action
+1. Create a basic test with one action
 2. Add a second action to create a flow
 3. Add error handling
 4. Organize into a test suite
 
 ⛔ Poor progression:
 
-1. Create a simple test
+1. Create a basic test
 2. Deploy to production (too big a jump)
 
 ### Explain the why
@@ -176,7 +176,7 @@ Tutorials should be encouraging:
 
 ✅ Good:
 
-> Great! You've created your first test. Let's make it more useful by adding another action.
+> Great. You've created your first test. Let's make it more useful by adding another action.
 
 ⛔ Too formal:
 
@@ -194,7 +194,7 @@ After each major step, show what users should see:
 > [PASS] test-1: Passed (2.3s)
 > ```
 >
-> This confirms your test ran successfully!
+> This confirms your test ran successfully.
 
 ⛔ Missing:
 
@@ -431,7 +431,7 @@ Now that you understand the basics:
 
 ## Checklist before submitting
 
-- [ ] Clearly states what users will learn
+- [ ] States what users will learn
 - [ ] Lists what users will build
 - [ ] Prerequisites and time estimate included
 - [ ] Steps build progressively

docs/contribute/docs/testing.mdx

@@ -407,7 +407,7 @@ npx doc-detective runTests --input your-test.spec.json --logLevel debug
 
 ## Test best practices
 
-### Keep tests simple
+### Keep tests straightforward
 
 ✅ **Do:**
 - Test one concept per test
@@ -424,7 +424,7 @@ npx doc-detective runTests --input your-test.spec.json --logLevel debug
 ### Make tests maintainable
 
 ✅ **Do:**
-- Use comments to explain non-obvious steps
+- Use comments to explain complex steps
 - Group related tests in the same file
 - Use descriptive action parameters
 - Clean up after tests (delete files, etc.)
@@ -513,7 +513,7 @@ Maintainers review tests as part of PR review. They can help with:
 - Optimizing test performance
 - Deciding what to test
 
-Don't hesitate to ask for help—testing documentation is a unique skill!
+Don't hesitate to ask for help—testing documentation is a unique skill.
 
 ## Next steps