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

Open Beginner friendly
  • Is something wrong?
#456 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
rust
Domain
documentation

Research direction

Read the affected sections in aimdb-tokio-adapter/README.md, aimdb-embassy-adapter/README.md, aimdb-core/README.md, and CONTRIBUTING.md, then compare them with aimdb-core/src/executor.rs and the workspace members in the root Cargo.toml. Update stale API and project structure references, removing the task spawning sections if that feature is gone. Done when the documentation matches the current API and workspace; consider whether make readme-check should cover per-crate READMEs.

Written by the indexing model from the issue text.

Description

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.

Dominant language
Rust
Stars
101
Forks
20
Avg merge
2h 33m
Merged PRs (30d)
90

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from aimdb-dev/aimdb

All issues in aimdb-dev/aimdb

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.