Skip to content
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

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

Open
3 tasks
Tracked by #19
Arlodotexe opened this issue Jun 19, 2023 · 0 comments
Open
3 tasks
Tracked by #19
Labels
dev loop ➰ For issues that impact the core dev-loop of building experiments documentation 📃 Improvements or additions to documentation sample app 🖼

Comments

@Arlodotexe
Copy link
Member

Arlodotexe commented Jun 19, 2023

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.

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.
@Arlodotexe Arlodotexe added documentation 📃 Improvements or additions to documentation dev loop ➰ For issues that impact the core dev-loop of building experiments sample app 🖼 labels Jun 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dev loop ➰ For issues that impact the core dev-loop of building experiments documentation 📃 Improvements or additions to documentation sample app 🖼
Projects
Status: 🔖 Ready
Development

No branches or pull requests

1 participant