Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Proposal: Update and refresh the documentation website

Aperta
  • Qualcosa non va?
#29 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
javascript
Ambito
documentation

Direzione di ricerca

Non sono indicati file, test o punti di ingresso. Inizia esaminando il sito web della documentazione esistente rispetto alla libreria, ai controlli, alle funzionalità, ai pacchetti e alle informazioni sulle release attuali. Il lavoro è completato quando la guida Getting Started, i dettagli dei pacchetti, gli esempi e le demo live sono aggiornati e allineati alle API e alle pratiche correnti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
JavaScript
Stelle
10
Fork
10
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.