improve user-friendliness of README file
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- python
- Área
- documentation
Línea de trabajo
Comienza por el README y revisa el enlace User guide en su tabla de contenidos, especialmente la sección sobre la sentencia smuggle y su gramática BNF. Reestructura la documentación para que una guía de inicio rápido y el User guide se centren en las funciones habituales, mientras el material técnico se traslada a páginas separadas; se considerará terminado cuando el README sea accesible para los nuevos usuarios sin eliminar el contenido de referencia técnica.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Good suggestion from one of our SoftwareX reviewers:
Currently, the README has a mix of user-friendly information and technical information, and the technical information may be intimidating to new users. This problem can be easily avoided by having a quick start section in the README and a user guide page that are focused only on the features that most users will need and moving the technical information to a separate page or pages.
For example, currently the "User guide" link in the TOC goes to a section on the smuggle statement, which starts with the grammar definition using BNF notation. Most users will have no idea what those symbols mean, so the BNF won't be very helpful for most users and may be intimidating to people who aren't serious Python developers.
- Lenguaje dominante
- TeX
- Estrellas
- 37
- Forks
- 8
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
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 ContextLab/davos
-
create a readthedocs pageAbiertodocumentation enhancement good first issue help wanted
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
ContextLab/davos#117 ·
-
Add Windows supportQuizá libre de nuevo @paxtonfitzpatrick la tomó hace 1105 días y no hay ningún pull request abierto. Abiertoenhancement
ContextLab/davos#113 · 7 comentarios · 1 reacción · 1 asignado ·
-
enhancement
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
ContextLab/davos#105 · 1 comentario ·
-
enhancement
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
ContextLab/davos#100 ·
-
enhancement
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
ContextLab/davos#99 · 1 comentario ·
Todos los issues de ContextLab/davos
Issues similares
-
area: docs difficulty: easy documentation good first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 69/100
manuscript-lang/manuscript#198 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
bug needs-acceptance
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
vllm-project/semantic-router#5002 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
Los mantenedores suelen responder en 1 día
-
.NET Azure Functions Docs OpenTelemetry
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
getsentry/sentry-dotnet#5715 · 1 comentario ·
Los mantenedores suelen responder en 2 días