docs: Refresh configuration function reference - #1705
Open
Gijs Reijn (Gijsreyn) wants to merge 1 commit into
Open
docs: Refresh configuration function reference#1705Gijs Reijn (Gijsreyn) wants to merge 1 commit into
Gijs Reijn (Gijsreyn) wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
Some updated intra-doc links now target heading-derived anchors that don’t match the explicit stable anchors defined in the CLI reference page, which risks broken links in published docs.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR refreshes DSC configuration function reference documentation (synced from Microsoft Learn) and updates related examples/metadata to match current function behavior and grouping.
Changes:
- Updated many existing function reference pages (front matter dates, clarified semantics, refreshed examples/CLI invocations, and improved multiline YAML readability).
- Added new function reference pages for lambda-based processing and extension import output (
lambda,lambdaVariables,map,filter,stdout). - Updated the functions overview page to regroup functions by category and include new functions.
File summaries
| File | Description |
|---|---|
| lib/dsc-lib/src/parser/functions.rs | Updates lambda usage examples in Rust doc comments. |
| docs/reference/schemas/config/functions/add.md | Refreshes metadata and example invocation formatting. |
| docs/reference/schemas/config/functions/array.md | Updates parameter requirement documentation. |
| docs/reference/schemas/config/functions/base64ToString.md | Refreshes metadata and example invocation formatting. |
| docs/reference/schemas/config/functions/bool.md | Refreshes metadata and clarifies valid string/number inputs. |
| docs/reference/schemas/config/functions/cidrHost.md | Refreshes metadata and updates example formatting/output. |
| docs/reference/schemas/config/functions/cidrSubnet.md | Refreshes metadata and updates multiline examples/output. |
| docs/reference/schemas/config/functions/coalesce.md | Refreshes metadata and example formatting. |
| docs/reference/schemas/config/functions/concat.md | Refreshes metadata and wraps long lines for readability. |
| docs/reference/schemas/config/functions/contains.md | Clarifies object-key-only behavior and updates examples. |
| docs/reference/schemas/config/functions/copy.md | Updates copy-loop documentation (including deprecation note) and examples. |
| docs/reference/schemas/config/functions/createObject.md | Refreshes metadata and improves multiline examples. |
| docs/reference/schemas/config/functions/dataUri.md | Updates description/output format to match current behavior. |
| docs/reference/schemas/config/functions/dataUriToString.md | Refreshes metadata and adjusts example formatting. |
| docs/reference/schemas/config/functions/div.md | Refreshes metadata and wraps long lines for readability. |
| docs/reference/schemas/config/functions/empty.md | Refreshes metadata and improves multiline examples/output formatting. |
| docs/reference/schemas/config/functions/endsWith.md | Refreshes metadata and improves multiline examples. |
| docs/reference/schemas/config/functions/equals.md | Updates syntax/semantics and examples to match current behavior. |
| docs/reference/schemas/config/functions/filter.md | Adds new reference page for filter(). |
| docs/reference/schemas/config/functions/greater.md | Refreshes metadata and minor formatting fixes. |
| docs/reference/schemas/config/functions/greaterOrEquals.md | Refreshes metadata and minor formatting fixes. |
| docs/reference/schemas/config/functions/if.md | Clarifies accepted return types and adds error-conditions section. |
| docs/reference/schemas/config/functions/indexOf.md | Refreshes metadata and improves example formatting. |
| docs/reference/schemas/config/functions/intersection.md | Refreshes metadata and reformats multi-arg examples/output. |
| docs/reference/schemas/config/functions/items.md | Refreshes metadata and adds missing top-level heading. |
| docs/reference/schemas/config/functions/join.md | Clarifies delimiter/element constraints and updates syntax block. |
| docs/reference/schemas/config/functions/json.md | Adds missing top-level heading and clarifies null parsing behavior. |
| docs/reference/schemas/config/functions/lambda.md | Adds new reference page for lambda(). |
| docs/reference/schemas/config/functions/lambdaVariables.md | Adds new reference page for lambdaVariables(). |
| docs/reference/schemas/config/functions/last.md | Refreshes metadata and adds missing top-level heading. |
| docs/reference/schemas/config/functions/lastIndexOf.md | Refreshes metadata and improves multiline examples. |
| docs/reference/schemas/config/functions/length.md | Updates example string formatting and expected length output. |
| docs/reference/schemas/config/functions/less.md | Refreshes metadata and minor formatting fixes. |
| docs/reference/schemas/config/functions/lessOrEquals.md | Refreshes metadata and minor formatting fixes. |
| docs/reference/schemas/config/functions/map.md | Adds new reference page for map(). |
| docs/reference/schemas/config/functions/mul.md | Refreshes metadata, fixes description, and updates example invocation. |
| docs/reference/schemas/config/functions/null.md | Refreshes metadata and wraps long lines for readability. |
| docs/reference/schemas/config/functions/objectKeys.md | Refreshes metadata, adds missing top-level heading, and reformats examples. |
| docs/reference/schemas/config/functions/overview.md | Regroups function listings by category and updates examples/CLI usage. |
| docs/reference/schemas/config/functions/parameters.md | Refreshes metadata and clarifies validation/evaluation error behavior. |
| docs/reference/schemas/config/functions/parseCidr.md | Refreshes metadata and improves multiline examples. |
| docs/reference/schemas/config/functions/path.md | Refreshes metadata and minor formatting/whitespace fixes. |
| docs/reference/schemas/config/functions/range.md | Refreshes metadata and adds missing top-level heading. |
| docs/reference/schemas/config/functions/reference.md | Refreshes metadata and clarifies return type/value semantics. |
| docs/reference/schemas/config/functions/resourceId.md | Refreshes metadata and adds output description. |
| docs/reference/schemas/config/functions/shallowMerge.md | Refreshes metadata, improves formatting, and clarifies behavior. |
| docs/reference/schemas/config/functions/skip.md | Refreshes metadata and adds missing top-level heading. |
| docs/reference/schemas/config/functions/startsWith.md | Refreshes metadata and improves multiline examples. |
| docs/reference/schemas/config/functions/stateChanged.md | Refreshes metadata and improves multiline examples. |
| docs/reference/schemas/config/functions/stdout.md | Adds new reference page for stdout(). |
| docs/reference/schemas/config/functions/string.md | Refreshes metadata and improves multiline examples/output. |
| docs/reference/schemas/config/functions/sub.md | Refreshes metadata and wraps long lines for readability. |
| docs/reference/schemas/config/functions/systemRoot.md | Refreshes metadata, fixes typos, and updates CLI flag link. |
| docs/reference/schemas/config/functions/take.md | Refreshes metadata and adds missing top-level heading. |
| docs/reference/schemas/config/functions/toLower.md | Refreshes metadata and improves multiline examples. |
| docs/reference/schemas/config/functions/toUpper.md | Refreshes metadata and improves multiline examples. |
| docs/reference/schemas/config/functions/tryGet.md | Refreshes metadata and improves multiline examples. |
| docs/reference/schemas/config/functions/tryIndexFromEnd.md | Refreshes metadata and improves multiline examples. |
| docs/reference/schemas/config/functions/tryWhich.md | Refreshes metadata and simplifies boolean logic example. |
| docs/reference/schemas/config/functions/union.md | Refreshes metadata and improves multiline examples. |
| docs/reference/schemas/config/functions/uniqueString.md | Refreshes metadata and improves multiline examples. |
| docs/reference/schemas/config/functions/uri.md | Refreshes metadata and improves multiline examples. |
| docs/reference/schemas/config/functions/uriComponent.md | Refreshes metadata and improves multiline examples. |
| docs/reference/schemas/config/functions/uriComponentToString.md | Refreshes front matter/syntax formatting and updates examples/CLI usage. |
Review details
Suppressed comments (1)
docs/reference/schemas/config/functions/parameters.md:116
- These link references use heading-derived anchors (
#-p---parameters,#-f---parameters-file), but the target page defines explicit stable anchors (<a id="--parameters"></a>,<a id="--parameters-file"></a>). Prefer the explicit anchors to prevent link rot if headings change.
- Files reviewed: 64/64 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
96
to
+98
| <!-- Link reference definitions --> | ||
| [01]: ../../../cli/config/index.md#--system-root | ||
| [02]: ./path.md No newline at end of file | ||
| [01]: ../../../cli/config/index.md#-r---system-root | ||
| [02]: ./path.md |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Summary
As requested, shortened the number of files and updated them based on separate schema groups.
PR context
Synced docs from Microsoft Learn: MicrosoftDocs/PowerShell-Docs-DSC#414