feat(site): Optimize site documentation typesetting #2688
Conversation
… English punctuation, and avoid excessive use of spaces for all Chinese text and comments within the site.
WalkthroughThe pull request focuses on updating documentation across multiple markdown files in the TinyVue project's demo and web documentation directory. The changes primarily involve improving readability, formatting, and clarity of explanations related to theme configuration, component imports, installation instructions, and changelog details. The modifications include adding consistent spacing, refining text descriptions, and updating code examples to enhance understanding for developers using the TinyVue framework. Changes
Suggested labels
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 (5)
examples/sites/demos/pc/webdoc/import-components.md (1)
Line range hint
1-300: Consider adding a table of contents.The document is well-structured but quite long. Consider adding a table of contents at the beginning to help users quickly navigate to different import methods.
Example TOC structure:
## 目录 - [自动导入（推荐）](#自动导入推荐) - [多组件引入](#多组件引入) - [vite 工程多组件引入按需加载和打包配置方法](#vite-工程多组件引入按需加载和打包配置方法) - [单组件引入](#单组件引入) - [完整引入（不推荐）](#完整引入不推荐)examples/sites/demos/pc/webdoc/changelog-en.md (1)
158-158: Minor grammar improvement needed.The breaking change is well-documented, but there's a minor grammatical issue. Consider removing the comma before "because" as it's an essential clause:
-Remove the `rich-text` component, because the third-party plug-in `quill` introduced by the component is an overdue high-risk dependency +Remove the `rich-text` component because the third-party plug-in `quill` introduced by the component is an overdue high-risk dependency🧰 Tools
🪛 LanguageTool
[formatting] ~158-~158: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...nges - Remove therich-textcomponent, because the third-party plug-inquillintrodu...(COMMA_BEFORE_BECAUSE)
examples/sites/demos/pc/webdoc/theme-en.md (2)
104-104: Fix bare URL in Chinese text section.The URL should be properly formatted as a markdown link for better readability and maintainability.
-旧主题不能 100% 还原历史版本的所有细节，如果用户升级后有较大的影响，可以跟我们反馈。也可以回退使用<code> @opentiny/vue@3.18.0 </code> 版本，我们将继续维护一段时间。 +旧主题不能 100% 还原历史版本的所有细节，如果用户升级后有较大的影响，可以[跟我们反馈](https://github.com/opentiny/tiny-vue/issues/new/choose)。也可以回退使用<code> @opentiny/vue@3.18.0 </code> 版本，我们将继续维护一段时间。
Line range hint
205-205: Inconsistent language usage in documentation.The documentation switches between English and Chinese without clear separation, which may confuse readers. Consider maintaining consistent language usage within each section.
Consider:
- Separating the content into distinct English and Chinese sections
- Using language tags to clearly indicate the language of each section
- Ensuring each section is complete in its respective language
Also applies to: 538-538
examples/sites/demos/pc/webdoc/changelog.md (1)
104-104: Format bare URLs as markdown linksThere are several bare URLs in the changelog that should be properly formatted as markdown links for better readability and consistency.
Apply this formatting to the URLs:
-https://github.com/opentiny/tiny-vue/pull/2588 +[#2588](https://github.com/opentiny/tiny-vue/pull/2588)Also applies to: 205-205, 538-538
🧰 Tools
🪛 Markdownlint (0.37.0)
104-104: null
Bare URL used(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (11)
examples/sites/demos/pc/webdoc/aui-adapter.md(4 hunks)examples/sites/demos/pc/webdoc/changelog-en.md(1 hunks)examples/sites/demos/pc/webdoc/changelog.md(4 hunks)examples/sites/demos/pc/webdoc/develop-demo.md(2 hunks)examples/sites/demos/pc/webdoc/faq-en.md(1 hunks)examples/sites/demos/pc/webdoc/faq.md(1 hunks)examples/sites/demos/pc/webdoc/form-valid.md(6 hunks)examples/sites/demos/pc/webdoc/import-components.md(2 hunks)examples/sites/demos/pc/webdoc/installation.md(3 hunks)examples/sites/demos/pc/webdoc/theme-en.md(1 hunks)examples/sites/demos/pc/webdoc/theme.md(7 hunks)
✅ Files skipped from review due to trivial changes (5)
- examples/sites/demos/pc/webdoc/develop-demo.md
- examples/sites/demos/pc/webdoc/form-valid.md
- examples/sites/demos/pc/webdoc/faq-en.md
- examples/sites/demos/pc/webdoc/installation.md
- examples/sites/demos/pc/webdoc/theme.md
🧰 Additional context used
🪛 Markdownlint (0.37.0)
examples/sites/demos/pc/webdoc/changelog.md
104-104: null
Bare URL used
(MD034, no-bare-urls)
205-205: null
Bare URL used
(MD034, no-bare-urls)
538-538: null
Bare URL used
(MD034, no-bare-urls)
🪛 LanguageTool
examples/sites/demos/pc/webdoc/changelog-en.md
[formatting] ~158-~158: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...nges - Remove the rich-text component, because the third-party plug-in quill introdu...
(COMMA_BEFORE_BECAUSE)
examples/sites/demos/pc/webdoc/aui-adapter.md
[uncategorized] ~27-~27: 数词与名词之间一般应存在量词，可能缺少量词。
Context: ...aaS 主题可以按照下述文档，进行打包配置更改： #### 方法一 方案一需要额外安装以下依赖： - @opentiny/vue-theme-saas` ...
(wa5)
🔇 Additional comments (5)
examples/sites/demos/pc/webdoc/import-components.md (2)
137-137: LGTM! Improved Chinese text readability.
The added spaces around "Tiny" and version number "3.17.0" follow proper Chinese typography practices and enhance readability.
200-200: LGTM! Improved comment readability.
The added space before the parentheses in the configuration comment improves readability while maintaining clarity of the options.
examples/sites/demos/pc/webdoc/faq.md (1)
15-17: LGTM! Clear and well-documented solution.
The comment improvement enhances readability while accurately explaining how to access the main application's window in a child application context.
examples/sites/demos/pc/webdoc/aui-adapter.md (2)
71-74: LGTM! Clear configuration example.
The template example clearly demonstrates how to inject the SaaS design configuration using the ConfigProvider component.
Line range hint 177-191: LGTM! Well-structured mode switching example.
The example effectively demonstrates different button styles across PC and multi-end modes, providing a clear reference for implementing mode-specific UI variations.
… English punctuation, and avoid excessive use of spaces for all Chinese text and comments within the site.
PR
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Issue Number: N/A
What is the new behavior?
Does this PR introduce a breaking change?
Other information
Summary by CodeRabbit
New Features
Dropdown,Notify, andActionMenu.ThemeDatainterface and thechangeThememethod.Bug Fixes
Tabs,Numeric counter,Grid table,DatePicker, andSelect.Documentation