docs: adapter READMEs and CONTRIBUTING describe a runtime API that no longer exists

Abierto Apto para principiantes
  • ¿Algo no está bien?
#456 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
78/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
rust
Área
documentation

Línea de trabajo

Lee las secciones afectadas de aimdb-tokio-adapter/README.md, aimdb-embassy-adapter/README.md, aimdb-core/README.md y CONTRIBUTING.md, y compáralas con aimdb-core/src/executor.rs y los miembros del workspace en el Cargo.toml raíz. Actualiza las referencias obsoletas a la API y a la estructura del proyecto, y elimina las secciones sobre la creación de tareas si esa función ya no existe. El trabajo estará listo cuando la documentación coincida con la API y el workspace actuales; considera si make readme-check debería abarcar los READMEs de cada crate.

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

Descripción

documentation

Problem

Several READMEs still document the runtime abstraction as it was before the Spawn trait and the aimdb-executor crate were removed. The runtime contract is now RuntimeOps in aimdb-core/src/executor.rs; there is no RuntimeAdapter trait, no Spawn trait and no aimdb-executor crate in the workspace.

Stale references found:

File Line(s) What it says
aimdb-tokio-adapter/README.md 61–63 impl RuntimeAdapter for TokioAdapter
aimdb-tokio-adapter/README.md 166–170 "Spawn background tasks using the Spawn trait", use aimdb_executor::Spawn;
aimdb-tokio-adapter/README.md 223 use aimdb_executor::{ExecutorError, ExecutorResult, Spawn};
aimdb-embassy-adapter/README.md 114–116 impl RuntimeAdapter for EmbassyAdapter
aimdb-embassy-adapter/README.md 248 use aimdb_executor::{ExecutorError, ExecutorResult};
aimdb-core/README.md 187 "Core consumes the runtime through aimdb-executor's dyn-safe RuntimeOps"
CONTRIBUTING.md 223 project structure lists aimdb-executor/; line 227 calls tools/aimdb-cli/ a "skeleton"

The snippets in the two adapter READMEs would not compile against the current crates.

Suggested work

  • Rewrite the affected sections against the current API (RuntimeOps, aimdb_core::executor::{ExecutorError, ExecutorResult}), or delete sections whose feature is gone (task spawning).
  • Refresh the project-structure block in CONTRIBUTING.md to match the workspace members in the root Cargo.toml.
  • Consider extending make readme-check to cover the per-crate READMEs so these snippets are compiled in CI; today it evidently does not catch them.

Notes

Found by static inspection (grep against the tree at d9c7be0); I did not try to compile the snippets.

Lenguaje dominante
Rust
Estrellas
101
Forks
20
Merge medio
2 h 33 min
PR fusionados (30 d)
90

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

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 aimdb-dev/aimdb

Todos los issues de aimdb-dev/aimdb

Issues similares

Más issues de Rust

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.