MaterialDesignInXAML / MaterialDesignInXAML/MaterialDesignInXamlToolkit

Proposal: Update and refresh the documentation website (materialdesigninxaml.net)

Abierto
#3,903 5 comentarios 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

enhancement evaluation required
Lenguaje dominante
C#
Estrellas
16.3k
Forks
3.5k
Merge medio
1 d 22 h
PR fusionados (30 d)
8

Descripción

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.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza revisando el sitio actual en materialdesigninxaml.net junto con el repositorio, la Wiki, las notas de versión y los paquetes NuGet actuales. Actualiza la guía Getting Started, añade cobertura y demostraciones en vivo para los controles y las funcionalidades más recientes, y actualiza los detalles de los paquetes, los fragmentos de código y los ejemplos. Se considera terminado cuando el sitio refleja las capacidades actuales de la biblioteca y las indicaciones de configuración.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
csharp
Área
documentation
Tipo de issue
Documentación
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.