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

Abierto Apto para principiantes
#26,614 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
72/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
docker, markdown

Línea de trabajo

Lee content/manuals/desktop/features/wasm.md y comprueba cómo encaja el aviso de obsolescencia con las secciones de configuración, ejemplos, tutorial y resolución de problemas. Elige una dirección clara para la página, como reducir las instrucciones de uso o añadir indicaciones para la migración, basándote en la información actual del proyecto. La tarea estará terminada cuando la página ofrezca a los lectores indicaciones coherentes sobre el estado de Wasm y qué hacer.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
Markdown
Estrellas
4.7k
Forks
8.5k
Merge medio
2 d 10 h
PR fusionados (30 d)
139

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de docker/docs

Todos los issues de docker/docs

Issues similares

Más issues de Content

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.