Proposal: Update and refresh the documentation website (materialdesigninxaml.net)
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 35/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- csharp
調査の方向性
まず、materialdesigninxaml.net の現在のサイトを、リポジトリ、Wiki、リリースノート、現在の NuGet パッケージと併せて確認します。Getting Started ガイドを更新し、新しいコントロールと機能のカバレッジおよびライブデモを追加して、パッケージの詳細、コードスニペット、例を刷新します。サイトがライブラリの現在の機能とセットアップ手順を反映していれば完了です。
索引モデルが issue の本文から書いたものです。
説明
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.
- 主要言語
- C#
- スター
- 16.3k
- フォーク
- 3.5k
- 平均マージ
- 1日 22時間
- マージ済み PR(30日)
- 10
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
MaterialDesignInXAML/MaterialDesignInXamlToolkit のほかの issue
-
enhancement up-for-grabs
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
MaterialDesignInXAML/MaterialDesignInXamlToolkit#2485 ·
メンテナーはふだん 1 日以内に返信
-
enhancement evaluation required
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
MaterialDesignInXAML/MaterialDesignInXamlToolkit#3997 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
bug evaluation required
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
MaterialDesignInXAML/MaterialDesignInXamlToolkit#3971 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
enhancement evaluation required
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
MaterialDesignInXAML/MaterialDesignInXamlToolkit#3918 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
bug evaluation required
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
MaterialDesignInXAML/MaterialDesignInXamlToolkit#3894 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
MaterialDesignInXAML/MaterialDesignInXamlToolkit の issue をすべて見る
似ている issue
-
needs-area-label
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
Fallout-build/Fallout#708 ·
メンテナーはふだん 5 日以内に返信
-
bug next version
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
Rem0o/FanControl.Releases#4220 · コメント 1 件 ·
-
area:repo audit:approved audit:auto priority:P3
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
elsa-workflows/elsa-core#8771 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
nkdAgility/azure-devops-migration-tools#3217 ·
メンテナーはふだん 1 日以内に返信