Suggested improvements to documentation
Los mantenedores suelen responder en 4 días
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 45/100
- Tipo de issue
- Documentación
- Claridad
- Necesita aclaración
- Estado de actividad
- Activo
- Stack tecnológico
- java, tensorflow
Línea de trabajo
Comienza con la documentación de Getting Started, el despliegue de API Javadocs en wayang.apache.org/docs/api/javadocs y las ramas main y deploy. Revisa cómo están organizados Requirements, Configure Wayang, Cost Functions y Scalable Machine Learning, y después define los cambios de documentación necesarios para cubrir abstraction, PlanBuilder y DLModel/TensorFlow. Se considerará completado cuando las secciones y páginas sugeridas estén organizadas de forma coherente y los Javadocs estén disponibles en la rama deploy.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
I might try to create a PR but for now, just jotting down some ideas that might improve the documentation:
- https://wayang.apache.org/docs/api/javadocs seems to be in your main branch but not your deploy branch
- "Getting started" has a mixture of information, I'd suggest moving "Requirements" to "How to build Wayang" and I'd suggest moving "Configure Wayang" and "Cost Functions" to a new page perhaps entitled "Configuring Wayang" or "Further details".
- I'd add an "Abstraction" section (to match style in "Scalable Machine Learning") in "getting started" with the unary/binary/loop/source/sink descriptions and maybe a little bit on PlanBuilder.
- There probably needs to be a "Scalable Deep Learning" doc to cover DLModel/TensorFlow.
- Lenguaje dominante
- Java
- Estrellas
- 274
- Forks
- 141
- Merge medio
- 10 d 19 h
- PR fusionados (30 d)
- 8
Preparar el entorno
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de apache/wayang
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
Los mantenedores suelen responder en 4 días
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 85/100
Los mantenedores suelen responder en 4 días
-
[Docs] Fix broken markdown formatting, leaked reviewer prompt, and outdated URLs in tutorial.mdAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
Los mantenedores suelen responder en 4 días
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
apache/wayang#732 · 3 comentarios ·
Los mantenedores suelen responder en 4 días
-
convert to configAbiertotodo
Dificultad 3/5 1-2 días Aptitud para principiantes 45/100
apache/wayang#776 · 1 comentario ·
Los mantenedores suelen responder en 4 días
Todos los issues de apache/wayang
Issues similares
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
openhab/openhab-core#5847 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
apache/parquet-java#3820 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
beehive-lab/jllm#187 ·