automated docs review

Abierto
#431 1 comentario 0 reacciones 0 asignados Ver en GitHub

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

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

enhancement help wanted

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

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 flashbots/contender

Todos los issues de flashbots/contender

Issues similares

Más issues de Rust

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.