Repository navigation
feat(home): rebrand the home promo card from SoybeanUI to VeanUI - #103
Conversation
- The home promo linked to `ui.soybeanjs.cn` and `github.com/soybeanjs/soybean-ui`, both of which now belong to the previous brand; point them at `veanui.com` and `github.com/soybeanjs/vean-ui` - Reflect the two-layer split in the copy: `@vean/aria` for unstyled interaction and a11y semantics, `@vean/ui` for styled wrappers - Refresh the component count to 96+, and give the card the VeanUI logo instead of the admin template's - Rename `SbUiPromo.vue` to `VeanUiPromo.vue` and its `soybean-ui-promo*` class prefix to `vean-ui-promo*`, keeping the style.css selectors in sync
Deploying soybean-admin-docs with
|
| Latest commit: |
93200ad
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://9ec33622.soybean-admin-docs-d90.pages.dev |
| Branch Preview URL: | https://feat-docs-rebrand-vean-ui.soybean-admin-docs-d90.pages.dev |
| <template> | ||
| <div class="vean-ui-promo"> | ||
| <div class="vean-ui-promo__brand"> | ||
| <img class="vean-ui-promo__logo" src="/vean-ui-logo.svg" alt="VeanUI logo" /> |
There was a problem hiding this comment.
资源缺失
新组件在三处引用 /vean-ui-logo.svg(桌面卡片、移动端入口、抽屉内 logo),但 PR 的 diff 中未出现 src/public/vean-ui-logo.svg 被新增。若该 SVG 实际未随本 PR 提交(或不在 VitePress 的 public 目录下),三种语言首页的 logo 图片都会 404,仅显示 alt 文本。PR 描述声称已添加该文件,但 diff 中不可见;不确定性在于 diff 可能被过滤,请确认该文件确实包含在变更中。
| siteHint: 'Official site', | ||
| githubText: 'GitHub', | ||
| githubHint: 'Source code' |
There was a problem hiding this comment.
遗留字段
promoCopy 仍传入 siteHint 和 githubHint,但新的 VeanUiPromo.vue 已不再声明或使用这两个属性(原 SbUiPromo 中对应的 <small> 提示文案被移除)。由于该组件是双根节点(.vean-ui-promo 与 .vean-ui-promo-mobile),无法自动继承多余属性,开发模式下 Vue 会对三个语言页面(src/index.md、src/jp/index.md、src/zh/index.md)输出 Extraneous non-props attributes 警告。属轻微问题:删除这两个遗留字段,或在组件中恢复使用即可。
PR Reviewer Guide 🔍(Review updated until commit 93200ad)Here are some key observations to aid the review process:
✅ Resolved findingssrc/index.md:78遗留无效属性
.vitepress/theme/VeanUiPromo.vue:27资源引用不一致 PR 描述称卡片改用本地资源 src/index.md:78-80遗留字段
.vitepress/theme/VeanUiPromo.vue:27资源缺失 新组件在三处引用 |
- Serve the logo from `https://img.soybeanjs.dev/logo-vean-ui.svg` instead of vendoring a copy under `src/public/`, keeping this repo from carrying an asset it does not own - `siteHint` and `githubHint` were left in `promoCopy` with no matching props on the promo component; the component has two root nodes, so Vue cannot fall through the extras and warns on every home page render
| <template> | ||
| <div class="vean-ui-promo"> | ||
| <div class="vean-ui-promo__brand"> | ||
| <img class="vean-ui-promo__logo" src="https://img.soybeanjs.dev/logo-vean-ui.svg" alt="VeanUI logo" /> |
There was a problem hiding this comment.
资源引用不一致
PR 描述称卡片改用本地资源 src/public/vean-ui-logo.svg,但组件内三处 <img>(桌面卡片、移动卡片、抽屉)实际都加载远程地址 https://img.soybeanjs.dev/logo-vean-ui.svg。这使所有语言版本的首页推广卡 logo 运行时依赖第三方图床:该域名不可达或路径变更时会出现裂图,且与描述所述实现不符。建议改用本地 SVG,或同步修正描述。
| drawerCloseLabel: 'Close SoybeanUI drawer', | ||
| directLinkLabel: 'Open veanui.com', | ||
| drawerCloseLabel: 'Close VeanUI drawer', | ||
| siteHint: 'Official site', |
There was a problem hiding this comment.
遗留无效属性
promoCopy 中仍保留 siteHint: 'Official site'(en/jp/zh 三个首页均相同),但新的 VeanUiPromo.vue 组件 props 已不再声明 siteHint,模板也未渲染它。由于该组件模板是多根节点(fragment),未声明的属性无法被自动继承,vitepress dev 下会触发 Vue 的 "Extraneous non-props attributes" 警告。应一并删除三处无用的 siteHint 字段。
|
Persistent review updated to latest commit 425d91c |
|
Persistent review updated to latest commit 93200ad |
User description
What
The home page promo card still advertised SoybeanUI, linking to
ui.soybeanjs.cnandgithub.com/soybeanjs/soybean-ui. Both now belong to the previous brand.Changes
veanui.comandgithub.com/soybeanjs/vean-ui@vean/aria(unstyled interaction + a11y semantics) and@vean/ui(styled wrappers)https://img.soybeanjs.dev/logo-vean-ui.svg) instead of the admin template'sSbUiPromo.vuerenamed toVeanUiPromo.vue, class prefixsoybean-ui-promo*renamed tovean-ui-promo*(style.css selectors synced)Notes
@soybeanjs/*to@vean/*, logic-layer packageheadlesstoaria, runtime contractdata-soybean-*/--soybean-*todata-vean-*/--vean-*. The two-layer split already existed before the rename, it was simply namedheadless/ui.src/public/, so this repo does not carry an upstream asset; the runtime therefore depends onimg.soybeanjs.devbeing reachable.soybeanjs.cnlinks (previews, legacy docs) point at unrelated products and were left alone.Verification
pnpm fmt/pnpm lint/pnpm typecheck/pnpm buildall exit 0. The built HTML at/and/zh/containsveanui.comand the new logo, with noSoybeanUIleft anywhere. Built HTML referenceshttps://img.soybeanjs.dev/logo-vean-ui.svg.PR Type
Documentation, Enhancement
Description
首页推广组件由
SbUiPromo.vue重命名为VeanUiPromo.vue链接与文案更新为 VeanUI(
veanui.com、@vean/aria、@vean/ui)组件数量由 91+ 刷新为 96+
CSS 类前缀
soybean-ui-promo*同步改为vean-ui-promo*移除无匹配 props 的
siteHint与githubHintDiagram Walkthrough
File Walkthrough
style.css
同步重命名推广卡片 CSS 类前缀.vitepress/theme/style.css
soybean-ui-promo*CSS 选择器重命名为vean-ui-promo*VeanUiPromo.vue
新增 VeanUI 推广组件.vitepress/theme/VeanUiPromo.vue
vean-ui-promo*veanui.com与github.com/soybeanjs/vean-uihttps://img.soybeanjs.dev/logo-vean-ui.svgSbUiPromo.vue
删除旧推广组件文件.vitepress/theme/SbUiPromo.vue
VeanUiPromo.vue取代index.md
更新英文首页推广文案与组件引用src/index.md
VeanUiPromo@vean/aria与@vean/uisiteHint与githubHintindex.md
更新日文首页推广文案与组件引用src/jp/index.md
VeanUiPromoveanui.com并移除冗余 propsindex.md
更新中文首页推广文案与组件引用src/zh/index.md
VeanUiPromoveanui.com并移除冗余 props