Add llms.txt for AI-friendly documentation discovery#3202
Add llms.txt for AI-friendly documentation discovery#3202jfversluis wants to merge 8 commits intomainfrom
Conversation
Introduces a /llms.txt file following the llmstxt.org specification to make .NET MAUI documentation more discoverable and effective for LLMs and AI-powered tools. The file provides a curated, structured overview of the most important documentation pages organized by topic area. Includes critical anti-pattern guidance (obsolete controls like ListView, TableView, Frame; layout pitfalls) and control selection recommendations informed by community best practices.
PoliCheck Scan ReportThe 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 foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
|
Learn Build status updates of commit 89afe4a: ✅ Validation status: passed
For more details, please refer to the build report. |
Add handler architecture, CollectionView, and performance best practices guides as primary entries in their respective sections. Move the detailed handler reference pages (create, customize) to the Optional section since the guide covers those topics comprehensively.
|
Learn Build status updates of commit 0fe157a: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue.
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. |
PoliCheck Scan ReportThe 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 foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
Address review feedback: link to raw markdown files on GitHub instead of rendered HTML pages. Raw markdown is cleaner for LLM consumption — no navigation chrome, JavaScript, or HTML conversion artifacts. All URLs now follow the pattern: https://raw.githubusercontent.com/dotnet/docs-maui/refs/heads/main/docs/...
|
Learn Build status updates of commit 0434cdc: ✅ Validation status: passed
For more details, please refer to the build report. |
|
Learn Build status updates of commit 91aab63: ✅ Validation status: passed
For more details, please refer to the build report. |
Three new standalone guides with inline code examples, no external snippet references or moniker ranges, designed to be fully self-contained for both human readers and LLM consumption: - Handler architecture: what handlers are, creating custom controls, customizing existing controls via Mapper, lifecycle, common recipes - CollectionView: data binding, layouts (list/grid), selection, grouping, empty views, scrolling, SwipeView, performance tips - Performance best practices: compiled bindings, control selection (Grid vs StackLayout, CollectionView vs ListView, Border vs Frame), layout optimization, images, startup, async/threading, memory, trimming/AOT
|
Learn Build status updates of commit 031641d: 💡 Validation status: suggestions
docs/user-interface/controls/collectionview/collectionview-guide.md
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. |
PoliCheck Scan ReportThe 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 foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
docs/llms.txt
Outdated
|
|
||
| ## User interface | ||
|
|
||
| - [**Handler architecture guide**](https://raw.githubusercontent.com/dotnet/docs-maui/refs/heads/main/docs/user-interface/handlers/handler-architecture.md): Comprehensive, self-contained guide to the handler architecture — what handlers are, creating custom controls, customizing existing controls via Mapper, handler lifecycle, and common recipes |
There was a problem hiding this comment.
There are multiple links with bold text.
Is there any specific reason why Handler architecture guide is in bold but not others?
PoliCheck Scan ReportThe 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 foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
|
Learn Build status updates of commit b03881e: 💡 Validation status: suggestions
docs/user-interface/controls/collectionview/collectionview-guide.md
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. |
All link entries now use plain text consistently, addressing review feedback about bold formatting only appearing on some links. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
PoliCheck Scan ReportThe 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 foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
1 similar comment
PoliCheck Scan ReportThe 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 foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
|
Learn Build status updates of commit b8a3770: 💡 Validation status: suggestions
docs/user-interface/controls/collectionview/collectionview-guide.md
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. |
2 participants
Introduces a /llms.txt file following the llmstxt.org specification to make .NET MAUI documentation more discoverable and effective for LLMs and AI-powered tools. The file provides a curated, structured overview of the most important documentation pages organized by topic area.
Includes critical anti-pattern guidance (obsolete controls like ListView, TableView, Frame; layout pitfalls) and control selection recommendations informed by community best practices.
Internal previews