Merge branch 'main' into promptless/add-dita-xml-documentation

Author: hawkeyexl

.doc-detective.json

@@ -1,29 +1,6 @@
 {
-  "input": ".",
-  "defaultCommand": "runTests",
-  "relativePathBase": "file",
-  "runTests": {
-    "input": ["./docs", "./blog"],
-    "recursive": true,
-    "detectSteps": true
-  },
-  "fileTypes": [
-    {
-      "name": "Markdown/MDX",
-      "extensions": [".md", ".mdx"],
-      "testStartStatementOpen": "<!-- test-start",
-      "testStartStatementClose": "-->",
-      "testIgnoreStatement": "<!-- test-ignore -->",
-      "testEndStatement": "<!-- test-end -->",
-      "stepStatementOpen": "<!-- step-start",
-      "stepStatementClose": "-->",
-      "markup": [
-        {
-          "name": "External hyperlink/image",
-          "regex": ["\\[.*?]\\(([^/].*?)\\)"],
-          "actions": ["checkLink"]
-        }
-      ]
-    }
-  ]
+  "$schema": "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/config_v3.schema.json",
+  "input": ["docs/get-started/installation/index.mdx"],
+  "allowUnsafeSteps": true,
+  "fileTypes": ["markdown"]
 }

.github/workflows/doc-detective.yml

@@ -1,11 +1,14 @@
 name: Doc Detective
 on:
+  workflow_dispatch:
   pull_request:
     branches:
       - main
   push:
     branches:
       - main
+  schedule:
+    - cron: '0 9 * * *'  # Runs at 1 AM Pacific (9 AM UTC) every day
 
 jobs:
   runTests:

.github/workflows/vale.yml

@@ -21,6 +21,6 @@ jobs:
         with:
           files: "docs/"
           fail_on_error: false
-          filter_mode: nofilter
+          vale_flags: "--minAlertLevel=error"
         env:
           GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

.vale.ini

@@ -10,3 +10,15 @@ Packages = MDX, Google, alex, Joblint
 BasedOnStyles = Vale, Google, alex, Joblint
 
 Vale.Terms = NO
+
+# Relax some rules for technical documentation
+# Google.Headings is too strict for camelCase API terms like runCode, goTo, etc.
+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/index.mdx

@@ -100,4 +100,4 @@ If you can't contribute time, you can [support Doc Detective financially](/suppo
 
 ## Next steps
 
-Ready to contribute? Choose your path above and get started!
+Ready to contribute? Choose your path above and get started.

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 happen and can usually be fixed.
 
 #### Vale failures
 
@@ -293,7 +293,7 @@ Celebrate! 🎉 You've contributed to open source! Post about it, add to your po
 
 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
 

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