MaterialDesignInXAML / MaterialDesignInXAML/MaterialDesignInXamlToolkit
Proposal: Update and refresh the documentation website (materialdesigninxaml.net)
Personne n'a encore pris cette issue.
- Langage dominant
- C#
- Étoiles
- 16.3k
- Forks
- 3.5k
- Merge moyen
- 1 j 22 h
- PR mergées (30 j)
- 8
Description
**Is your feature request related to a problem? Please describe.**
Yes, the current documentation website, https://materialdesigninxaml.net/, appears to be significantly outdated. As a developer using the library, this creates several challenges:
* It doesn't showcase many of the new controls, features, and packages that have been added in recent versions.
* This can lead to confusion, as users might not be aware of the full capabilities of the toolkit and may spend time trying to create solutions that already exist.
* New users may have a difficult time getting started, as the information they find on the official site doesn't align with the latest NuGet packages and best practices.
* It can give the incorrect impression that the project is not actively maintained, which is far from the truth given the great work done in the repository.
**Describe the solution you'd like**
I propose a comprehensive update to the website to bring it in line with the current state of the library. This would ideally include:
* Updating the "Getting Started" guide to reflect the latest installation and setup procedures.
* Adding documentation and live demos for newer controls and features that are currently missing.
* Updating information about the available NuGet packages (like the color tool, transitions, etc.) and their specific functionalities.
* Ensuring all code snippets and examples are up-to-date with the latest API and best practices.
**Describe alternatives you've considered**
The main alternative is for users to rely solely on the GitHub repository, the Wiki, and release notes to understand new features. While this is possible for experienced users, it presents a high barrier to entry for newcomers and is less efficient than having a centralized, user-friendly documentation site that serves as the project's "front door".
**Additional context**
First of all, thank you for this fantastic library! It's an invaluable tool for WPF developers. An updated website would greatly improve the user experience, help with adoption, and better showcase the incredible progress the project has made. I believe this would be a significant enhancement for the entire community.
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par examiner le site actuel à l’adresse materialdesigninxaml.net ainsi que le dépôt, le Wiki, les notes de version et les packages NuGet actuels. Mettez à jour le guide Getting Started, ajoutez une couverture et des démonstrations en direct pour les contrôles et fonctionnalités plus récents, et actualisez les détails des packages, les extraits de code et les exemples. Le travail est terminé lorsque le site reflète les capacités actuelles de la bibliothèque et les instructions de configuration.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- csharp
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100