MaterialDesignInXAML / MaterialDesignInXAML/MaterialDesignInXamlToolkit

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

Open
#3,903 5 comments 1 reaction 0 assignees View on GitHub
enhancement evaluation required
Dominant language
C#
Stars
16.3k
Forks
3.5k
Avg merge
1d 22h
Merged PRs (30d)
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.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the current site at materialdesigninxaml.net alongside the repository, Wiki, release notes, and current NuGet packages. Update the Getting Started guide, add coverage and live demos for newer controls and features, and refresh package details, code snippets, and examples. Done means the site reflects the library's current capabilities and setup guidance.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.