automated docs review
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Stack tecnológico
- rust
- Área
- ci-cd, documentation, testing
Línea de trabajo
No se nombran archivos, pruebas ni puntos de entrada. Empieza revisando la documentación y la configuración de CI del repositorio; después, determina cómo deben identificarse y ejecutarse los ejemplos de Rust. Se considerará terminado cuando exista un enfoque acordado que compruebe de forma fiable los ejemplos de la documentación, con cualquier recomendación opcional para el PR delimitada explícitamente.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Is your feature request related to a problem? Please describe.
It would be great if there was a CI job that could read the docs, run the examples, and make sure everything was still correct as we merge new PRs. As time passes and features get added/removed, docs (especially those that are example-oriented) can drift away from usefulness.
Describe the solution you'd like
There are a lot of possible solutions to this problem. We could use a simple parser to extract the rust examples and run them, but that could get convoluted quickly. We could also use AI. I don't know which is the best yet, but I'm just writing this quickly so a discussion can start.
The goal (first & foremost) ensure accuracy of code examples in docs.
If we can add AI code reviews and recommendations related to the PR (i.e. to remind the PR's dev to update the docs) that would be an excellent addition.
- Lenguaje dominante
- Rust
- Estrellas
- 144
- Forks
- 58
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
- Incluye un Dockerfile o un archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
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 flashbots/contender
-
engine_newPayload filesAbiertoenhancement
Dificultad 5/5 Más de una semana Aptitud para principiantes 45/100
-
server: generate reportsAbiertoenhancement
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
-
server: export DB from sessionQuizá libre de nuevo @zeroXbrock la tomó hace 203 días y no hay ningún pull request abierto. Abiertoenhancement help wanted question
-
enhancement
Dificultad 4/5 3-5 días Aptitud para principiantes 62/100
-
bug
Dificultad 3/5 1-2 días Aptitud para principiantes 52/100
Todos los issues de flashbots/contender
Issues similares
-
priority middle
Dificultad 1/5 Menos de una hora Aptitud para principiantes 72/100
KATO-Hiro/AtCoderClans#13029 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
RustCrypto/formats#2544 ·
Los mantenedores suelen responder en 1 día
-
bug ui
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
userFRM/egui-charts#3363 ·
Los mantenedores suelen responder en 1 día
-
ada documentation mobile report
Dificultad 1/5 Menos de una hora Aptitud para principiantes 86/100
physicsdolphin/nv-uefi-unlocker#254 · 2 reacciones ·
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
kindraywind/rustnarok-client#1382 ·
Los mantenedores suelen responder en 1 día