SuperAPI AI 工具集

rerun-docs

写作与研究

查看项目

更新于 10-16 09:50

技能介绍

用途:Rerun 的文档源与其中展示的每段代码片段都是本地纯文件。回答 Rerun 工作原理、组件用法等问题前,应先读这些文件,而非凭记忆猜测。

位置:在 Rerun 检出目录中位于 docs/;在 Rerun Viewer 的 agent 面板中,解包后位于 skills 旁边,相对本文件为 ../../../docs,会话前言会给出绝对路径。

目录结构:docs/content/**/*.md 为网站页面,docs/content/concepts/<name>.md 对应 rerun.io/docs/concepts/<name>;docs/content/reference/types/ 为 archetype、component、view、blueprint 类型各一页;docs/content/reference/viewer/、reference/sdk/、reference/cli.md 为 viewer、SDK、CLI 参考(含 viewer-mcp server);docs/content/howto/ 与 getting-started/ 为面向任务的指南与教程;docs/content/changelog/ 为发布说明(由旧到新)。docs/snippets/INDEX.md 列出全部片段(功能、名称、一行描述、可用语言),应从此开始;docs/snippets/all/<category>/<name>.{py,rs,cpp} 为片段本体,目录含 archetypes/、views/、howto/、concepts/、tutorials/、quick_start/,同名即同一示例。每个 markdown 页以 front matter(title、order)开头。片段旁的 *.rrd 录制文件不随 viewer 分发。

用法:先搜索再阅读,例如 rg -l "<term>" docs/content docs/snippets/all;问“如何 log X”时看 docs/snippets/all/archetypes/<x>.py(或 .rs、.cpp)及 docs/content/reference/types/archetypes/<x>.md;问“X 如何工作”时看 docs/content/concepts/。给用户指路时用由文件路径推导的网站 URL,而非本地路径。

限制:Python API 参考与 docs.rs/rerun 不在磁盘上,需用 WebFetch 获取。