-
Notifications
You must be signed in to change notification settings - Fork 839
docs: Add comprehensive samples catalog with structured metadata and deprecation warnings #22276
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
base: master
Are you sure you want to change the base?
Conversation
Co-authored-by: Jen-Uno <214558326+Jen-Uno@users.noreply.github.com>
|
|
Co-authored-by: Jen-Uno <214558326+Jen-Uno@users.noreply.github.com>
|
|
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 addresses issue #20884 by creating a comprehensive samples catalog with structured metadata to help users quickly identify samples matching their requirements without needing to click through to each one. The documentation now includes detailed information about .NET versions, project structures, target frameworks, UnoFeatures, dependencies, and tutorial availability, along with prominent warnings for deprecated packages and outdated migration guides.
Key Changes:
- New samples catalog page with detailed metadata tables for each sample (Featured Applications, Workshop Projects, Uno.Samples Repository entries, and Legacy/Migration Samples)
- Enhanced community tutorials page with structured information including author credentials, publication dates, and currency assessment guidance
- Added prominent deprecation warnings to the Silverlight migration landing page highlighting outdated content from 2021
- New sample documentation template for future contributions
- Updated navigation structure separating "Samples Catalog" from "Samples Repository"
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
doc/articles/toc.yml |
Added new "Samples Catalog" navigation entry separate from "Samples Repository" to distinguish between the informational catalog and the GitHub repository |
doc/articles/samples-tutorials-overview.md |
Added prominent link to the new Samples Catalog page and clarified that Samples Repository refers to the GitHub repository containing the actual projects |
doc/articles/samples-catalog.md |
New 260-line comprehensive catalog with structured metadata tables for all major samples, including .NET versions, project structures, UnoFeatures, deprecation warnings for IdentityServer4 and IdentityModel.OidcClient, and beginner guidance |
doc/articles/guides/silverlight-migration/silverlight-migration-landing.md |
Added comprehensive CAUTION notice warning that the Silverlight migration documentation is outdated (2021), uses deprecated packages, and should not be used for current development |
doc/articles/guides/community-tutorials.md |
Transformed from simple list to structured resource with detailed author information, publication dates, tutorial series breakdowns, and guidance on assessing tutorial currency and adapting older content |
doc/.sample-template.md |
New reusable template for documenting samples with consistent metadata structure, ensuring future sample documentation follows the same comprehensive format established in the catalog |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
|
PR Type:
📚 Documentation content changes
What is the current behavior? 🤔
Sample and tutorial documentation lacks structured information. Users must click through to determine if a sample matches their requirements (project structure, .NET version, target platforms, dependencies). No warnings exist for deprecated packages (IdentityServer4 EOL Dec 2022, IdentityModel.OidcClient) or outdated migration guides (Silverlight). External tutorials presented without currency indicators.
What is the new behavior? 🚀
New Samples Catalog Page (
samples-catalog.md, 260 lines)Structured metadata tables for each sample:
Navigation aids:
Safety warnings:
Enhanced Community Tutorials Page
Transformed from simple list to structured resource:
Added guidance on assessing tutorial currency (publication date, .NET version, project structure).
Silverlight Migration Warning
Added prominent CAUTION notice highlighting outdated content (2021 patterns, deprecated packages, legacy project structures) with links to current resources.
Sample Documentation Template (
.sample-template.md)Reusable template ensuring consistent metadata documentation for future contributions.
PR Checklist ✅
Other information ℹ️
Files changed: 6 files (+599, -12 lines)
samples-catalog.md,.sample-template.mdcommunity-tutorials.md,silverlight-migration-landing.md,samples-tutorials-overview.md,toc.ymlAll xref links validated against existing UIDs. Markdown syntax and table formatting verified.
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.