-
Notifications
You must be signed in to change notification settings - Fork 25.1k
[10.0] API doc cross-links #36336
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[10.0] API doc cross-links #36336
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR updates documentation across multiple ASP.NET Core files by adding API documentation cross-references (xref links) to replace inline code references and text descriptions. The changes primarily target .NET 10.0 content, converting method names, property names, and type references to proper xref syntax that links to official API documentation.
Key Changes
- Replaced inline code-styled API references with xref syntax throughout passkeys, Blazor, and OpenAPI documentation
- Removed "UPDATE 10.0" comment markers indicating that API cross-links have been completed
- Updated metadata dates to reflect documentation changes
- Cleaned up preview-specific content and comments for the .NET 10.0 release
Reviewed Changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| aspnetcore/security/authentication/passkeys/index.md | Added xref links for Identity passkey APIs including IdentityPasskeyOptions properties, SignInManager methods, and UserPasskeyInfo; updated ms.date metadata |
| aspnetcore/security/authentication/passkeys/blazor.md | Cleaned up preview SDK references and simplified prerequisites section |
| aspnetcore/fundamentals/openapi/customize-openapi.md | Added xref for AddOpenApiOperationTransformer API |
| aspnetcore/blazor/state-management/server.md | Added xref links for CircuitOptions properties and PersistentState attribute; contains grammar error |
| aspnetcore/blazor/state-management/prerendered-state-persistence.md | Added consistent xref links for PersistentState attribute usage across multiple sections |
| aspnetcore/blazor/javascript-interoperability/index.md | Added xref links for JS interop methods including InvokeConstructorAsync, GetValueAsync, and SetValueAsync |
| aspnetcore/blazor/javascript-interoperability/call-javascript-from-dotnet.md | Added comprehensive xref links for JSRuntime methods and IJSObjectReference APIs |
| aspnetcore/blazor/forms/validation.md | Added xref links for ValidationServiceCollectionExtensions.AddValidation and ValidatableType attribute |
| aspnetcore/blazor/forms/input-components.md | Added xref link for InputHidden component |
| aspnetcore/blazor/components/quickgrid.md | Added xref links for QuickGrid component methods (RowClass, HideColumnOptionsAsync) and fixed moniker range placement |
| aspnetcore/blazor/components/integration.md | Added xref link for PersistentState attribute |
| aspnetcore/blazor/call-web-api.md | Added xref links for JsonPatch APIs; contains incorrect NuGet package URL |
Co-authored-by: Copilot <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great. I don't see any additional issues. Approved.
Fixes #36335
Only one review needed.
Anywhere that you see "MIA API," I'll need to talk to the PU about the API missing. We'll need to file requests to get it marked for inclusion. I'll take care of it later. 🏃♂️
Internal previews
Toggle expand/collapse