feat: optimize docs #1337
feat: optimize docs #1337
Conversation
Walkthrough本次更新主要涉及对 Changes
Poem
Tip Early access features
Note:
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 as PR comments)
Additionally, you can add CodeRabbit Configration 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
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- docs/api.md (2 hunks)
- docs/config.md (2 hunks)
Additional context used
LanguageTool
docs/config.md
[grammar] ~17-~17: The word ‘mako’ is not correct in this context. Consider using the plural form, adding a determiner like ‘the’ or ‘a’, or adding a preposition like ‘at’ or ‘in’.
Context: ...s" } } ``` Notice: When you're using mako with Umi, prefer to config the bundler ...(BE_VBG_NN)
[formatting] ~129-~129: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ... used in server-side rendering scenarios, because when server-side rendering, you don't n...(COMMA_BEFORE_BECAUSE)
[formatting] ~183-~183: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...ing a pure server-side rendering project, because assets files are not needed at this tim...(COMMA_BEFORE_BECAUSE)
[formatting] ~320-~320: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ... configuration can only be used with umd, because injecting CSS is not a recommended way ...(COMMA_BEFORE_BECAUSE)
[uncategorized] ~404-~404: Loose punctuation mark.
Context: ... Output related configuration. -path, output directory -mode, output mode,...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~419-~419: Loose punctuation mark.
Context: ...on items are supported. -skipModules, optimize the size by skipping modules w...(UNLIKELY_OPENING_PUNCTUATION)
[formatting] ~429-~429: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...o setdynamicImportToRequiretotrue, because the runtime does not yet support node-s...(COMMA_BEFORE_BECAUSE)
[uncategorized] ~457-~457: Loose punctuation mark.
Context: ...e compilation process of Mako. -name, plugin name -buildStart, called befo...(UNLIKELY_OPENING_PUNCTUATION)
[typographical] ~459-~459: Two consecutive commas
Context: ...type supportscss,js,jsx,ts,tsx-generateEnd, called after Generate completes, `isFir...(DOUBLE_PUNCTUATION)
[uncategorized] ~503-~503: Loose punctuation mark.
Context: ...r to enable px2rem conversion. -root, root font size, default is100- `pro...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~551-~551: Loose punctuation mark.
Context: ... }resolveconfiguration. -alias, alias configuration -extensions`, fil...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~611-~611: Loose punctuation mark.
Context: ...iguration items: -clientComponentTpl, client component template, use `{{path}...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~612-~612: Loose punctuation mark.
Context: ...resent the id of the module. -emitCSS, whether to output CSS components. ### ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~623-~623: Loose punctuation mark.
Context: ... Child configuration items: -modules, whether to generate module information,...(UNLIKELY_OPENING_PUNCTUATION)
Additional comments not posted (7)
docs/api.md (5)
Line range hint
7-11: 示例代码清晰示例代码提供了如何使用
@umijs/mako的build函数，结构清晰，无需更改。
22-24: 数据类型名称修正将数据类型名称从大写改为小写提高了文档的一致性和准确性。
29-31: 数据类型名称修正将数据类型名称从大写改为小写提高了文档的一致性和准确性。
36-38: 数据类型名称修正将数据类型名称从大写改为小写提高了文档的一致性和准确性。
36-38: 数据类型名称修正将数据类型名称从大写改为小写提高了文档的一致性和准确性。
docs/config.md (2)
264-264: 修正描述中的大小写将
flexBugs的描述中的大小写进行了修正，提高了文档的清晰度和一致性。
372-372: 默认值说明修正修正了
minify属性的默认值说明，使其根据模式的不同更为清晰和准确。
Summary by CodeRabbit
api.md中的数据类型和格式，包括修正标点符号，将数据类型从大写改为小写，以及更新默认值。config.md中的描述，“Whether to fix flexbugs” 改为 “Whether to fix flexBugs”，并澄清了minify部分关于默认值基于开发模式或生产模式的说明。