docs(@vben/docs): update settings doc #6128
Conversation
wyc001122
requested review from
anncwb,
vince292007,
mynetfan,
jinmao88 and
a team
as code owners
|
WalkthroughThe documentation for application settings was updated to reflect changes in default preferences and interface definitions. New properties were added to various preference sections, some default values were modified, and a warning about cache clearing was included. Interface definitions were extended to support the new and updated preference properties. Changes
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/src/en/guide/essentials/settings.md (2)
168-168: Nitpick: Improve warning phrasing
Consider splitting the sentence for clarity. For example:
“Please clear the cache after changing the configuration. Otherwise, it may not take effect.”
295-295: Nitpick: Widget property ordering
Therefreshentry has moved ahead ofsidebarToggle—consider grouping all widget flags consistently or adding a comment about the intended order.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/src/en/guide/essentials/settings.md(14 hunks)docs/src/guide/essentials/settings.md(10 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/src/en/guide/essentials/settings.md
[typographical] ~564-~564: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...ease clear the cache after changing the configuration, otherwise it may not take effect. :::
(THUS_SENTENCE)
⏰ Context from checks skipped due to timeout of 90000ms (7)
- GitHub Check: Lint (ubuntu-latest)
- GitHub Check: Lint (windows-latest)
- GitHub Check: Test (windows-latest)
- GitHub Check: Analyze (javascript-typescript)
- GitHub Check: Check (windows-latest)
- GitHub Check: post-update (ubuntu-latest)
- GitHub Check: post-update (windows-latest)
🔇 Additional comments (17)
docs/src/en/guide/essentials/settings.md (8)
63-84: Added production environment variables block
Well done extending the docs with a dedicated.env.productionexample. This mirrors the development block and covers key flags (VITE_COMPRESS,VITE_PWA, etc.).
218-218: Approve newsettingShowdefault property
AddingsettingShow: trueto control visibility in the settings panel is a valuable enhancement. Confirm the type declaration in your core config matches.
221-221: Default footer visibility updated
Switchingfooter.enabletofalsebetter reflects the lean default. Verify the same change exists in the framework defaults.
227-227: Documented new headermenuAlignproperty
Good addition ofmenuAlign: 'start'. Please make sure the core type (LayoutHeaderMenuAlignType) and default are in sync.
249-257: Reviewed sidebar default configuration updates
The additions (collapsedButton,fixedButton), adjustment ofextraCollapse, and resize ofwidthto224improve UX. Ensure these defaults are reflected in the source config.
261-271: Reviewed tabbar default configuration updates
New properties (maxCount,middleClickToClose,wheelable) and updatedheightenhance customization. Confirm your code’s defaults match the docs.
281-281: Updated themesemiDarkSidebardefault
SwitchingsemiDarkSidebartofalsealigns with the new design direction. Verify this change in the core theme defaults.
199-199:✅ Verification successful
Verify default
loginExpiredModematches code
The default has been changed to'page'. Please ensure this aligns with the actual default inpackages/@core/preferences/src/config.ts.Run:
🏁 Script executed:
rg -n "loginExpiredMode" packages/@core/preferences/src/config.tsLength of output: 98
Default
loginExpiredModeVerifiedThe default value of
loginExpiredModeis confirmed to be'page'inpackages/@core/preferences/src/config.ts(line 22). The documentation is already accurate—no changes needed.docs/src/guide/essentials/settings.md (9)
61-82: 新增生产环境.env.production配置示例
文档中新增了生产环境的环境变量示例，涵盖了压缩、PWA、路由模式等配置，请与项目根目录下的.env.production保持一致。
167-167: 清缓存提示
“更改配置后请清空缓存，否则可能不生效” 提示清晰，用户友好。
198-198: 登录过期模式默认值更新
将loginExpiredMode默认值改为page，请确认packages/@core/preferences/src/config.ts中同步更新。
217-217: 新增settingShow属性
添加settingShow: true，用于控制设置面板中版权项显示。请检查类型声明是否一致。
220-220: 底栏默认不可见
将footer.enable默认为false，与英文版一致。请确认核心配置中也做了同样修改。
226-226: 顶栏菜单对齐属性
新增menuAlign: 'start'，请与核心配置的默认值保持一致。
248-255: 侧边栏默认配置更新
新增collapsedButton、fixedButton，调整extraCollapse与width为224，请确认源配置文件中的默认设置。
260-269: 标签栏默认配置更新
新增maxCount、middleClickToClose、wheelable，并将height更新为38。请核对代码中对应值。
280-280: 主题半深色侧边栏默认值更新
将semiDarkSidebar默认为false，请核实核心主题默认配置。
Co-authored-by: wyc001122 <[email protected]>
* 'main' of https://github.com/baohaojie123/vue-vben-admin: fix: refresh command of tabbar issue, fixed: vbenjs#6162 (vbenjs#6169) feat: support to refresh the tab page by route name (vbenjs#6153) fix: delete useless code (vbenjs#6143) docs(@vben/docs): update settings doc (vbenjs#6128) fix: tsconfig moduleResolution (vbenjs#6122)
Description
packages/@core/preferences/src/config.ts更新，英文文档也同步更新.env.productionType of change
Please delete options that are not relevant.
Checklist
pnpm run docs:devcommand.pnpm test.feat:,fix:,perf:,docs:, orchore:.Summary by CodeRabbit
Documentation
New Features
Style