SuperAPI AI 工具集

documenting-warehouse-sources

写作与研究

查看项目

更新于 10-16 08:08

技能介绍

用途:为 PostHog Data warehouse 导入源编写或更新面向用户的 posthog.com 文档。用户可见的源文档位于 posthog.com 仓库(非本仓库)的 contents/docs/cdp/sources/<slug>.md,同时通过 /docs/cdp/sources/<slug> 与 /docs/data-warehouse/sources/<slug> 提供访问。发布新源时可与 /implementing-warehouse-sources 配合使用。

主要能力:定义每个源文档必须遵循的统一结构。连接字段与表格列表无需手写,由站点构建时从 public_source_configs API 获取并通过 MDX 组件渲染:<SourceParameters /> 渲染 get_source_config.fields 的连接/配置表单字段;<SourceTables /> 渲染 get_documented_tables() 的受支持表格参考(表名、描述、同步方式、增量字段、主键)。<SourceTables /> 仅在源类设置 lists_tables_without_credentials = True 时才有数据(仅当 get_schemas 遍历静态端点目录且无 I/O 时有效),否则渲染通用的“从你的账户发现”提示。表格缺失或描述单薄时应修改源代码(settings.py 端点与 canonical_descriptions.py),而非文档。

使用方式:frontmatter 需包含 title、sidebar、showTitle、availability、sourceId(必须等于 ExternalDataSourceType 值,如 ActiveCampaign、Stripe,PascalCase),beta 源可加 beta: true。sourceId 用于将文档链接到 API 配置,写错会导致无数据渲染。必备章节:状态提示(仅 alpha/beta)、简介、Prerequisites、Adding a data source、Sync modes、Configuration、Supported tables、Troubleshooting。可选章节按需添加:Webhooks、CDC、列选择、行过滤、入站 IP 地址、数据类型处理、已知限制、ERD/关系。复用共享片段(位于 contents/docs/cdp/_snippets/):source-setup-intro.mdx、sync-modes.mdx、alpha-release.mdx / beta-release.mdx、dw-troubleshooting-link.mdx、inbound-ip-addresses.mdx、feedback-questions.mdx。.md 文档支持 MDX 导入,无需改名为 .mdx。CalloutBox、ProductScreenshot、SourceParameters、SourceTables 为全局组件,无需导入。

slug 规则:文档文件名 <slug>.md、源 docsUrl(https://posthog.com/docs/cdp/sources/<slug>)与列表链接三者必须一致,多词 slug 用 kebab-case。写完或重命名后运行:python manage.py audit_source_docs --docs-dir ../posthog.com/contents/docs/cdp/sources。重命名已发布文档还需在 posthog.com/vercel.json 为 /docs/cdp/sources/* 与 /docs/data-warehouse/sources/* 添加 301。

限制:假定存在同级 posthog.com 检出(如 ../posthog.com)。文档仅渲染 API 返回内容,代码是唯一事实来源。