docs: adapter READMEs and CONTRIBUTING describe a runtime API that no longer exists
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 78/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- rust
调研方向
阅读 aimdb-tokio-adapter/README.md、aimdb-embassy-adapter/README.md、aimdb-core/README.md 和 CONTRIBUTING.md 中受影响的部分，然后将其与 aimdb-core/src/executor.rs 以及根目录 Cargo.toml 中的 workspace 成员进行比较。更新过时的 API 和项目结构引用；如果任务启动功能已不存在，则删除相关章节。文档与当前 API 和 workspace 相符时即为完成；考虑 make readme-check 是否应覆盖每个 crate 的 README。
由索引模型根据 Issue 内容生成。
描述
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.mdto match the workspace members in the rootCargo.toml. - Consider extending
make readme-checkto 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.
- 主要语言
- Rust
- 星标
- 101
- 派生
- 20
- 平均合并
- 2 小时 33 分钟
- 30 天内合并 PR
- 90
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
aimdb-dev/aimdb 的其他 Issue
-
🏷️ good first issue enhancement
难度 2/5 1-3 小时 新手友好度 74/100
维护者通常 1 天内回复
-
enhancement
难度 2/5 1-3 小时 新手友好度 85/100
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 82/100
维护者通常 1 天内回复
-
enhancement
难度 5/5 一周以上 新手友好度 35/100
维护者通常 1 天内回复
-
dependencies
难度 4/5 3-5 天 新手友好度 44/100
维护者通常 1 天内回复
相似的 Issue
-
Panic on live viewport resize when unstyled elements exist in display: none subtree可能已有人在做 @GoCoder7 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 78/100
DioxusLabs/blitz#1488 ·
维护者通常 1 天内回复
-
S-Needs triage
难度 2/5 1-3 小时 新手友好度 68/100
维护者通常 2 天内回复
-
难度 2/5 1-3 小时 新手友好度 77/100
vectordotdev/vrl#2042 ·
维护者通常 2 天内回复
-
难度 2/5 1-3 小时 新手友好度 62/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 62/100
维护者通常 1 天内回复