docs(tree): improve withDefault API docs and cross-link with user-facing docs - #27651
Merged
Conversation
- Expanded TSDoc for SchemaStaticsAlpha.withDefault with structured remarks covering required vs optional fields, value vs generator defaults, and a self-contained example - Added link from API docs to fluidframework.com default field values guide - Added link from withDefaultRecursive to recursive types section of user-facing docs - Added cross-reference from NodeProvider to withDefault - Added API reference tip callout near top of user-facing docs page linking to withDefault, withDefaultRecursive, and NodeProvider - Expanded See Also section with direct links to individual API members Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Contributor
|
Hi! Thank you for opening this PR. Want me to review it? Based on the diff (85 lines, 2 files), I've queued these reviewers:
How this works
|
Contributor
|
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output |
Contributor
Bundle size comparisonBase commit: Notable changesNo bundles changed by ≥ 500 bytes parsed. Per-bundle deltas
|
Craig Macomber (Microsoft) (CraigMacomber)
approved these changes
Jul 7, 2026
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.
Description
The
withDefaultAPI docs (TSDoc) and the user-facing documentation page existed independently without linking to each other, making it harder for users to discover the full picture from either entry point.This PR improves the
withDefaultdocumentation in two ways:API docs (TSDoc): Expanded the
withDefaultremarks with structured guidance on required vs optional field defaults, value vs generator defaults, and a self-contained example showing a realistic schema. Added{@link}references to the fluidframework.com default field values guide from bothwithDefaultandwithDefaultRecursive. Added a cross-reference fromNodeProviderback towithDefault.User-facing docs (website): Linked
withDefault,withDefaultRecursive, andNodeProviderinline where they are first referenced, so users can jump to the API reference for type signatures and parameter details. Expanded the See Also section with direct links to individual API members.Reviewer Guidance
The review process is outlined on this wiki page.
Documentation-only change -- no API surface or behavioral changes. No changeset needed.