CommunityToolkit / CommunityToolkit/Tooling-Windows-Submodule

Implement Markdown Rendering Support for Notes, Warnings, and Info in Sample App

Ouverte
#70 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub
dev loop ➰ documentation :page_with_curl: sample app 🖼
Langage dominant
C#
Étoiles
56
Forks
19
Merge moyen
40 min
PR mergées (30 j)
1

Description

## Background
The sample applications for both CommunityToolkit vNext and CommunityToolkit Labs currently utilize an "Experimental" InfoBar with "Informational" severity.

## Problem
The aforementioned notice is exclusively applicable to Labs components and is not removable in the Toolkit vNext sample app.

## Solution
- [ ] Remove the notice from the sample app.
- [ ] Integrate the notice as a feature of the markdown renderer within the sample app. This will allow for better rendering of documents that contain elements like `![NOTE] Some information`, which currently do not render as expected.
- [ ] Update existing markdown in Labs and Toolkit vNext to include the experimental InfoBar. We'll remove them from vNext when we launch stable.

This change will enhance the readability of our documentation and ensure consistent user experience across both CommunityToolkit vNext and CommunityToolkit Labs.

## Open questions
Both DocFX and GitHub have their own syntax for this.
- GitHub: https://github.com/orgs/community/discussions/16925
- DocFX: https://dotnet.github.io/docfx/docs/markdown.html?tabs=linux%2Cdotnet#alerts

Which one do we want to use?
- If we use **GitHub** syntax, it will display on GitHub correctly, but need to be transformed to the DocFX format when we add support for that.
- If we use **DocFX** syntax, it won't need to be transformed before being built for DocFX, but it also won't show up right on GitHub.

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par le moteur de rendu Markdown des applications d’exemple et examinez l’Experimental InfoBar existante dans CommunityToolkit vNext et Labs. Comparez les syntaxes d’alerte GitHub et DocFX référencées dans l’issue, puis décidez quel format le moteur de rendu et le Markdown existant doivent utiliser. C’est terminé lorsque l’avis a été supprimé de vNext, qu’il est rendu de manière cohérente dans les deux exemples et que le Markdown pertinent de Labs et vNext contient la syntaxe d’alerte choisie.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
csharp, markdown
Domaine
documentation
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
30/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.