Fix Broken Docs Links, Docs Linting and Missing Functions

[Alex-shearing]

Fix broken docs links using markdown-link-check.
Fix linting issues using textlint and fixed issues.
Add documentation for:

• secret function
• path function
• systemRoot function

[Alex-shearing]

@Alex-shearing please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

• (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.

@microsoft-github-policy-service agree

• (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.

@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

@microsoft-github-policy-service agree

[Copilot]

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Documentation-focused PR to improve consistency and correctness across DSC reference docs, including new configuration function references and many link/terminology updates.

Changes:

• Standardizes terminology (e.g., “command-line”, “Visual Studio Code”, “SemVer”, “URLs”, “array elements”).
• Adds new reference docs for config functions (path, secret, systemRoot) and updates related-function/link lists.
• Updates many internal doc links and resource reference paths to new locations/casing.

Reviewed changes

Copilot reviewed 47 out of 48 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
docs/reference/tools/registry/schema/index.md	Terminology update (“array element”).
docs/reference/tools/builtin.md	Standardizes “command-line”.
docs/reference/schemas/schema-uris.md	Expands “VS Code” to “Visual Studio Code”; line wrapping changes.
docs/reference/schemas/resource/stdout/list.md	Standardizes “SemVer”.
docs/reference/schemas/resource/manifest/schema/embedded.md	Expands “VS Code” to “Visual Studio Code”.
docs/reference/schemas/resource/manifest/root.md	Standardizes “URLs”, “SemVer”; renames provider->adapter references and link.
docs/reference/schemas/outputs/resource/list.md	Standardizes “SemVer”.
docs/reference/schemas/outputs/extension/list.md	Standardizes “SemVer”.
docs/reference/schemas/extension/manifest/root.md	Standardizes “URLs”, “Visual Studio Code”, “SemVer”.
docs/reference/schemas/config/resource.md	Fixes glossary link path.
docs/reference/schemas/config/functions/uri.md	Updates related-functions list and link refs.
docs/reference/schemas/config/functions/trim.md	Standardizes “whitespace”; updates related-functions list.
docs/reference/schemas/config/functions/systemRoot.md	Adds new function reference doc.
docs/reference/schemas/config/functions/string.md	Tweaks Base64 wording.
docs/reference/schemas/config/functions/secret.md	Adds new function reference doc.
docs/reference/schemas/config/functions/resourceId.md	Fixes glossary link path.
docs/reference/schemas/config/functions/path.md	Adds new function reference doc.
docs/reference/schemas/config/functions/parameters.md	Updates CLI anchor links.
docs/reference/schemas/config/functions/overview.md	Terminology update (“array elements”).
docs/reference/schemas/config/functions/objectKeys.md	Fixes link target for copy.
docs/reference/schemas/config/functions/last.md	Removes example/related references to split().
docs/reference/schemas/config/functions/join.md	Standardizes “hostnames”.
docs/reference/schemas/config/functions/items.md	Removes toObject() mentions/links.
docs/reference/schemas/config/functions/envvar.md	Updates CLI anchor link.
docs/reference/schemas/config/functions/array.md	Standardizes “key-value”.
docs/reference/schemas/config/document.md	Standardizes “URLs”, “Visual Studio Code”, “runtime”.
docs/reference/resources/overview.md	Updates resource reference links and casing/paths.
docs/reference/resources/Microsoft/Windows/WindowsPowerShell/index.md	Fixes schema link target.
docs/reference/resources/Microsoft/Windows/WMI/index.md	Fixes schema link target.
docs/reference/resources/Microsoft/Windows/Registry/index.md	Fixes capitalization and Microsoft Learn URL.
docs/reference/resources/Microsoft/Windows/RebootPending/examples/check-for-pending-reboot.md	Adjusts relative link depth.
docs/reference/resources/Microsoft/DSC/Transitional/WindowsPowerShellScript/index.md	Updates links to capabilities + example file rename.
docs/reference/resources/Microsoft/DSC/Transitional/RunCommandOnSet/index.md	Updates capabilities link/anchor.
docs/reference/resources/Microsoft/DSC/Transitional/RunCommandOnSet/examples/run-powershell-command.md	Updates CLI link target/path.
docs/reference/resources/Microsoft/DSC/Transitional/RunCommandOnSet/examples/run-a-simple-command.md	Fixes relative link depth.
docs/reference/resources/Microsoft/DSC/Transitional/PowerShellScript/index.md	Updates links to capabilities + example file rename.
docs/reference/resources/Microsoft/DSC/PowerShell/index.md	Updates “See also” link + ref links to new examples/schema.
docs/reference/resources/Microsoft/DSC/Debug/echo/index.md	Fixes relative link depths to concepts/resources and OSInfo.
docs/reference/resources/Microsoft/DSC/Debug/echo/examples/basic-echo-example.md	Fixes relative link depth.
docs/reference/resources/Microsoft/Adapter/PowerShell/index.md	Updates schema/type-name link to resourceType definition.
docs/reference/resources/Microsoft/Adapter/PowerShell/examples/configure-a-machine.md	Expands “VS Code” and adjusts CLI link depths.
docs/reference/resources/DSC/PackageManagement/Brew/examples/remove-a-package.md	Standardizes “macOS”.
docs/reference/resources/DSC/PackageManagement/Brew/examples/install-a-package-with-brew.md	Standardizes “macOS”.
docs/reference/cli/config/index.md	Updates guidance about combining --parameters and --parameters-file.
docs/overview.md	Standardizes “Bash”.
docs/glossary.md	Standardizes “command-line”.
docs/concepts/resources/overview.md	Tweaks “key-value” phrasing.
docs/concepts/resources/anatomy.md	Standardizes “SemVer”.

Comments suppressed due to low confidence (17)

docs/reference/schemas/config/functions/systemRoot.md:1

• The YAML front matter opener is -- instead of ---, which will break doc site parsing/build. Change the first line to --- (matching the closing delimiter).
  docs/reference/schemas/config/functions/secret.md:1
• The YAML front matter opener is -- instead of ---, which will break doc site parsing/build. Change the first line to --- (matching the closing delimiter).
  docs/reference/schemas/resource/manifest/root.md:1
• After renaming provider -> adapter, this paragraph still says “call the provider” on the list sentence, but then continues with “adapter can manage”. Update the sentence to consistently refer to the adapter (e.g., “call the adapter ... the adapter can manage”).
  docs/reference/schemas/config/functions/secret.md:1
• The example shows a realistic-looking secret value and explicitly echoes it to output. For security guidance, consider using a clearly non-sensitive placeholder value (e.g., ExampleSecretValue) and/or adding a short note warning users not to print secrets in logs/output.
  docs/reference/schemas/config/functions/secret.md:1
• The example shows a realistic-looking secret value and explicitly echoes it to output. For security guidance, consider using a clearly non-sensitive placeholder value (e.g., ExampleSecretValue) and/or adding a short note warning users not to print secrets in logs/output.
  docs/reference/schemas/config/functions/systemRoot.md:1
• Fix typos and the CLI example: “pf” should be “of”, “overriden” should be “overridden”, and the command uses ---system-root (triple hyphen) and an unusual argument order. Update it to the correct flag spelling (--system-root) and a valid invocation order for the CLI.
  docs/reference/schemas/config/functions/systemRoot.md:1
• Fix typos and the CLI example: “pf” should be “of”, “overriden” should be “overridden”, and the command uses ---system-root (triple hyphen) and an unusual argument order. Update it to the correct flag spelling (--system-root) and a valid invocation order for the CLI.
  docs/reference/schemas/config/functions/systemRoot.md:1
• systemRoot() is described as returning a system root path; the declared output type includes non-string types. Unless the function can truly return multiple JSON types, the output type should be string to match the described behavior (and avoid confusing users).
  docs/reference/schemas/config/functions/path.md:1
• The YAML example is not valid due to incorrect indentation (e.g., type/properties/output are misaligned under the list item). Fix the indentation so type and properties are peers of name, and output is nested under properties.
  docs/reference/schemas/config/functions/path.md:1
• The output block duplicates messages and hadErrors twice. Remove the duplicated pair to avoid confusion and keep the example consistent with other command outputs.
  docs/reference/schemas/config/functions/path.md:1
• There are several typos and small grammar issues in this new doc: “acounting” -> “accounting”, the example filename for Example 3 should match the example number (doubleDot.example.3...), “a absolute” -> “an absolute”, “Sytstem32” -> “System32”, and “seperators” -> “separators” (also add a space in OS (e.g., ...)).
  docs/reference/schemas/config/functions/path.md:1
• There are several typos and small grammar issues in this new doc: “acounting” -> “accounting”, the example filename for Example 3 should match the example number (doubleDot.example.3...), “a absolute” -> “an absolute”, “Sytstem32” -> “System32”, and “seperators” -> “separators” (also add a space in OS (e.g., ...)).
  docs/reference/schemas/config/functions/path.md:1
• There are several typos and small grammar issues in this new doc: “acounting” -> “accounting”, the example filename for Example 3 should match the example number (doubleDot.example.3...), “a absolute” -> “an absolute”, “Sytstem32” -> “System32”, and “seperators” -> “separators” (also add a space in OS (e.g., ...)).
  docs/reference/schemas/config/functions/path.md:1
• There are several typos and small grammar issues in this new doc: “acounting” -> “accounting”, the example filename for Example 3 should match the example number (doubleDot.example.3...), “a absolute” -> “an absolute”, “Sytstem32” -> “System32”, and “seperators” -> “separators” (also add a space in OS (e.g., ...)).
  docs/reference/schemas/config/functions/trim.md:1
• The sentence after the line break starts with a lowercase word: “whitespace characters include ...” should start with “Whitespace” since it begins a new sentence.
  docs/reference/schemas/resource/manifest/schema/embedded.md:1
• Typo in heading: “keywordds” should be “keywords”.
  docs/reference/resources/Microsoft/Windows/RebootPending/examples/check-for-pending-reboot.md:1
• Typo in link text: “capabiltiies” should be “capabilities”.

---