MaterialDesignInXAML / MaterialDesignInXAML/MaterialDesignInXamlToolkit

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

Đang mở
#3,903 5 bình luận 1 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

enhancement evaluation required
Ngôn ngữ chính
C#
Star
16.3k
Fork
3.5k
Merge trung bình
1 ngày 22 giờ
Pull request đã merge (30 ngày)
8

Mô tả

**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.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu bằng cách xem xét trang web hiện tại tại materialdesigninxaml.net cùng với repository, Wiki, release notes và các gói NuGet hiện tại. Cập nhật hướng dẫn Getting Started, bổ sung nội dung và bản demo trực tiếp cho các control và tính năng mới hơn, đồng thời làm mới thông tin gói, các đoạn mã và ví dụ. Công việc được xem là hoàn tất khi trang web phản ánh các khả năng hiện tại của thư viện và hướng dẫn thiết lập.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
csharp
Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
35/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.