docs: publish SDK 0.20.8 (regenerated API, new modules, examples, deployments)#3
Merged
Conversation
…ments)
Publishes the v0.20.8 docs to the latest channel (was still 0.16.23 content).
- API: regenerated via TypeDoc at SDK 0.20.8. Module set now matches the real
packages — adds @aastar/{admin,airaccount,channel,x402}, drops the consolidated
community/analytics. apiSidebar updated; a frozen apiSidebarArchived keeps the
/0.16.23/ archive sidebar intact.
- Examples: examples/index.md now indexes the standalone aastar-examples repo
(embed-widget, starter-site) + links the YAA full reference app.
- Deployments: refreshed Sepolia contract addresses to match the @aastar/core
canonical address book (single source of truth); Optimism/OP-Sepolia already
matched. Fixed a dead L3 sidebar link.
- License: latest-channel MIT badges -> Apache-2.0 (zh getting-started/sdk-readme,
guide/docs/API_REFERENCE). Homepage version badge 0.16.6 -> 0.20.8.
- Markdown sanitized for VitePress (escape <jwt>/<void>/<T> pseudo-tags) so the
Vue compiler build passes; verified 'pnpm run docs:build' succeeds.
Nav version dropdown: v0.20.8 (latest) / v0.16.23.
Deploying aastar-docs with
|
| Latest commit: |
d7efd17
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://974ceccb.aastar-docs.pages.dev |
| Branch Preview URL: | https://docs-sync-sdk-0-20-8.aastar-docs.pages.dev |
api/**/_media/ holds TypeDoc-copied example source (.ts/.md) with placeholder keys like 0x1234567890abcdef… — published examples, not real secrets. Exclude _media like other generated output so the scan stops failing on the 0.20.8 API docs. Real-source coverage (hand-authored docs/config, contextual private-key assignments everywhere) is unchanged.
clestons
approved these changes
Jun 18, 2026
clestons
left a comment
clestons
left a comment
There was a problem hiding this comment.
clestons review — #3 [2-round, APPROVE]
docs: publish SDK 0.20.8 (regenerated API, new modules, examples, deployments) — 文档更新正确，1170 个 TypeDoc 再生文件 + 28 个手写变更均无问题，两轮通过。
关键变更确认
.github/workflows/check-secrets.yml — 添加 |_media 到 EXCLUDED_DIRS ✅
_media/ 存放 TypeDoc 生成的示例源码（含 placeholder 地址如 0x1234…），与生成的 api/ 相同性质；注释说明清晰，不影响真实密钥扫描。
.vitepress/config.ts — 关键修复：apiSidebarArchived 分离 ✅
'/0.16.23/api/': prefixSidebar(apiSidebarArchived, ARCHIVED_VERSION),
// ^^^^^^^^^^^^^^^^^^^
// 原为 apiSidebar，导致 v0.16.23 归档页显示 airaccount/channel/x402 等
// 该版本根本不存在的包。现在冻结为归档时的包列表。当前 apiSidebar 新增结构化导航（Getting Started / Core Modules 12包 / Examples），v0.20.8 版本标签更新 ✅
guide/deployments/verify.sepolia.contracts.md — 合约地址同步至 2026-06-16 重新部署 ✅（纯文档，不影响运行时）
guide/getting-started.md — 更新为 @aastar/sdk 单包 + 子路径结构，多链配置示例正确（chain.id 自动解析地址，无需硬编码）✅
guide/installation.md — integrity hash v0.16.23 → v0.20.8 ✅
1170 个 api/ 文件 — TypeDoc 再生，机械性输出，无需逐一审查 ✅
轮次摘要
- Sonnet: 全部变更正确；
apiSidebarArchived分离是实质性修复；check-secrets_media排除合理
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
目标
把 docs.aastar.io 的 latest 频道从 0.16.23 内容更新到 0.20.8(SDK 已发布 0.20.8)。归档
/0.16.23/不动。内容
@aastar/{admin,airaccount,channel,x402},移除已并入单包模型的community/analytics。config.ts的apiSidebar更新为 13 包;另存apiSidebarArchived保持/0.16.23/归档侧边栏不被改动。examples/index.md改为索引独立的 aastar-examples 仓库(embed-widget、starter-site)+ 链接 YAA 完整参考应用;说明新示例以后落在该仓库。@aastar/corecanonical 地址簿(唯一可信源,2026-06-16 redeploy);Optimism / OP-Sepolia 经核对已一致。修复一个失效的 L3 侧边栏链接。<jwt>/<void>/<T>等伪标签做消毒转义(VitePress 的 Vue 编译器会把它们当未闭合标签报错),已本地验证pnpm run docs:build通过。版本下拉:v0.20.8 (latest) / v0.16.23。
关联
extract-docs.sh路径失效/自清理/动态包列表 + sanitizer)docs/api提交对齐:aastar-sdk issue #103