Skip to content

Add xref API doc links to maui/markup/markup.md#629

Merged
jfversluis merged 2 commits intomainfrom
copilot/fix-include-api-doc-links
Mar 16, 2026
Merged

Add xref API doc links to maui/markup/markup.md#629
jfversluis merged 2 commits intomainfrom
copilot/fix-include-api-doc-links

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 16, 2026

MAUI API docs are now published, so xref links can be added to Microsoft.Maui.* types referenced in the markup documentation.

Changes

  • Prose text: Linked first mentions of Grid, Label, Entry to their API docs
  • Converters section: Linked IValueConverter and IMultiValueConverter
  • Extensions table: Linked all MAUI type references in descriptions — View, AbsoluteLayout, BindableObject, Binding, Element, FlexLayout, Image, IImage, ItemsView, CarouselView, CollectionView, Label, IPlaceholder, Style, ITextAlignment, VisualElement

Format follows existing convention in the repo:

[`View`](xref:Microsoft.Maui.Controls.View)
[`IImage`](xref:Microsoft.Maui.IImage)

Types left unlinked: IDynamicResourceHandler (internal API, no public docs), Grid on line 121 (not in backticks in original), property names like EmptyView/Margin/HorizontalTextAlignment.

Original prompt

This section details on the original issue you should resolve

<issue_title>Include API doc links</issue_title>
<issue_description>Currently it is not possible to include any xrefs to Microsoft.Maui.* because the API docs for MAUI have not been published.

This is here to remind us that when those docs do we published we should go through the docs pages and fix up any places where an xref should be made.

Current known pages are:

  • maui/markup/markup.md</issue_description>

Comments on the Issue (you are @copilot in this section)


📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.

@learn-build-service-prod
Copy link
Copy Markdown

Learn Build status updates of commit bf3def1:

⚠️ Validation status: warnings

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

@jfversluis jfversluis marked this pull request as ready for review March 16, 2026 08:50
@jfversluis jfversluis added the maui The .NET MAUI Community Toolkit label Mar 16, 2026
Co-authored-by: jfversluis <939291+jfversluis@users.noreply.github.com>
@learn-build-service-prod
Copy link
Copy Markdown

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link
Copy Markdown

Learn Build status updates of commit 8a2b1df:

✅ Validation status: passed

File Status Preview URL Details
docs/maui/markup/markup.md ✅Succeeded View

For more details, please refer to the build report.

Copilot AI changed the title [WIP] Fix include API doc links for Microsoft.Maui Add xref API doc links to maui/markup/markup.md Mar 16, 2026
Copilot AI requested a review from jfversluis March 16, 2026 08:57
@jfversluis jfversluis merged commit 920651d into main Mar 16, 2026
3 checks passed
@jfversluis jfversluis deleted the copilot/fix-include-api-doc-links branch March 16, 2026 09:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

maui The .NET MAUI Community Toolkit

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Include API doc links

3 participants