[docs-scanner] Wasm documentation scope conflicts with deprecation status

Ouverte Adaptée aux débutants
  • Quelque chose ne va pas ?
#26,614 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
72/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
Active
Stack technique
docker, markdown
Domaine
content, documentation

Piste de recherche

Lisez content/manuals/desktop/features/wasm.md et vérifiez comment l’avis de dépréciation s’articule avec les sections consacrées à la configuration, aux exemples, au tutoriel et au dépannage. Choisissez une orientation claire pour la page, par exemple en réduisant les instructions d’utilisation ou en ajoutant des conseils de migration, en vous fondant sur les informations actuelles du projet. Le travail est terminé lorsque la page fournit aux lecteurs des indications cohérentes sur le statut de Wasm et la marche à suivre.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

File: content/manuals/desktop/features/wasm.md

Issue

The page opens with a clear deprecation notice:

Wasm workloads are deprecated and will be removed in a future Docker Desktop release. This feature is no longer actively maintained.

However, the rest of the page provides extensive, detailed instructions for enabling and using Wasm workloads, including:

  • Complete setup instructions ("Turn on Wasm workloads")
  • Multiple usage examples with docker run and Docker Compose
  • A multi-service application tutorial with step-by-step instructions
  • Building and pushing Wasm modules
  • Detailed troubleshooting section
Why this matters

A reader encountering this page faces conflicting signals:

  1. The deprecation notice suggests they should not invest time in this feature
  2. The comprehensive documentation (setup, examples, tutorials, troubleshooting) suggests this is a fully-supported feature worth learning

This creates confusion about whether users should:

  • Ignore the feature entirely (suggested by deprecation)
  • Learn and use it (suggested by the extensive documentation)
  • Migrate away from it (not addressed)
Suggested fix

Given the deprecation status, consider one of these approaches:

Option 1: Minimal documentation

  • Keep only the deprecation notice and basic description
  • Remove detailed setup, usage examples, and troubleshooting
  • Add a brief note about what users should use instead (if applicable)

Option 2: Migration-focused documentation

  • Keep the deprecation notice prominent
  • Add a section explaining migration path or alternatives
  • Reduce the emphasis on setup/usage and increase emphasis on "if you're currently using this, here's what to do"

Option 3: Clarify the timeline

  • If the feature will remain available for a significant period, clarify this in the deprecation notice
  • Example: "Wasm workloads are deprecated and will be removed in Docker Desktop 5.0 (estimated Q2 2025). This feature is no longer actively maintained but remains available for existing users."

The current approach of "deprecated but here's how to use it extensively" sends mixed messages to readers.

Found by nightly documentation quality scanner

Langage dominant
Markdown
Étoiles
4.7k
Forks
8.5k
Merge moyen
2 j 10 h
PR mergées (30 j)
139

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de docker/docs

Toutes les issues de docker/docs

Issues similaires

Plus d'issues Content

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.