MaterialDesignInXAML / MaterialDesignInXAML/MaterialDesignInXamlToolkit
Proposal: Update and refresh the documentation website (materialdesigninxaml.net)
还没有人认领这个 Issue。
- 主要语言
- C#
- 星标
- 16.3k
- 派生
- 3.5k
- 平均合并
- 1 天 22 小时
- 30 天内合并 PR
- 8
描述
**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.
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
首先检查 materialdesigninxaml.net 上的当前网站,以及 repository、Wiki、release notes 和当前的 NuGet packages。更新 Getting Started 指南,为较新的控件和功能添加覆盖内容与实时演示,并刷新包详细信息、代码片段和示例。当网站反映库当前的功能以及设置指导时,即视为完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- csharp
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 5/5
- 预计耗时
- 一周以上
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100