๐ docs: update docs #2669
๐ docs: update docs #2669
Conversation
|
@RubuJam is attempting to deploy a commit to the LobeHub Team on Vercel. A member of the Team first needs to authorize it. |
WalkthroughThe recent updates primarily focus on refining the documentation for feature development and contribution guidelines. Key changes include renumbering and linking sections for better navigation, introducing new sections for local development setup, code style, contribution guidelines, and internationalization. Additionally, an important note was added to avoid errors during code commits. Changes
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 (
|
|
๐ @RubuJam Thank you for raising your pull request and contributing to our Community |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
Outside diff range and nitpick comments (11)
contributing/Basic/Intro.zh-CN.md (1)
Line range hint
111-111: Improve grammatical structure for better readability.- ๅฆๆไฝ ๆไปปไฝ็้ฎ๏ผๆ่ ้่ฆ่ฟไธๆญฅ็ๅธฎๅฉ๏ผ่ฏทไธ่ฆ็น่ฑซ๏ผ่ฏท้่ฟไธ่ฟฐๆธ ้ไธๆไปฌ่็ณปใ + ๅฆๆไฝ ๆไปปไฝ็้ฎๆ้่ฆ่ฟไธๆญฅๅธฎๅฉ๏ผ่ฏทไธ่ฆ็น่ฑซ๏ผ้่ฟไธ่ฟฐๆธ ้ไธๆไปฌ่็ณปใcontributing/Basic/Feature-Development.zh-CN.md (4)
Line range hint
204-204: Improve grammatical accuracy in the sentence.- ้่ฟไปฅไธ็ๅฎ็ฐ๏ผๆไปฌๅฏไปฅ็กฎไฟๅจๆทปๅ ๆฐ็ไผ่ฏ็ปๅ๏ผๅบ็จ็็ถๆไผๅๆถๆดๆฐ๏ผไธ็ธๅ ณ็็ปไปถไผๆถๅฐๆๆฐ็็ถๆๅนถ้ๆฐๆธฒๆใ่ฟ็งๆนๅผ... + ้่ฟไปฅไธ็ๅฎ็ฐ๏ผๆไปฌๅฏไปฅ็กฎไฟๅจๆทปๅ ๆฐ็ไผ่ฏ็ปๅ๏ผๅบ็จ็็ถๆไผๅๆถๆดๆฐ๏ผไธ็ธๅ ณ็็ปไปถไผๆถๅฐๆๆฐ็ถๆๅนถ้ๆฐๆธฒๆใ่ฟ็งๆนๅผ...
Line range hint
268-268: Ensure grammatical consistency in the documentation.- ่ฟๅฐไฟ่ฏ็ถๆไธๆๆฐ็ไผ่ฏๆฐๆฎๅๆญฅใ + ่ฟๅฐ็กฎไฟ็ถๆไธๆๆฐ็ไผ่ฏๆฐๆฎไฟๆๅๆญฅใ
Line range hint
319-319: Adjust the sentence for better clarity and grammatical accuracy.- ้ฆๅ ๆฅ่ฏขๆๆไผ่ฏ็ป๏ผ็ถๅๅบไบ่ฟไบ็ป็ ID ๆฅ่ฏข่ชๅฎไนไผ่ฏ็ป๏ผๅๆถๆฅ่ฏข้ป่ฎคๅๅบๅฎ็ไผ่ฏใๆๅ๏ผๅฎ่ฟๅไธไธชๅ ๅซๆๆไผ่ฏๅๆ็ปๅ็ฑป็ไผ่ฏๅ่กจๅฏน่ฑกใ + ้ฆๅ ๆฅ่ฏขๆๆไผ่ฏ็ป๏ผ็ถๅๅบไบ่ฟไบ็ป็ ID ๆฅ่ฏข่ชๅฎไนไผ่ฏ็ป๏ผๅๆถๆฅ่ฏข้ป่ฎคๅๅบๅฎ็ไผ่ฏใๆๅ๏ผ่ฟๅไธไธชๅ ๅซๆๆไผ่ฏๅๆ็ปๅ็ฑป็ไผ่ฏๅ่กจๅฏน่ฑกใ
Line range hint
120-120: Add alternative text to images for accessibility.-  + contributing/Basic/Feature-Development.md (6)
Line range hint
120-120: Images should have alternate text (alt text) for accessibility.-  + 
Line range hint
391-391: Fenced code blocks should have a language specified for better readability.- ```diff + ```diff javascriptAlso applies to: 522-522
Line range hint
465-465: Consider replacing "very simple" with "straightforward" to avoid overused intensifiers.- ...en that the migration implementation is very simple. However, it is important to ensure the... + ...en that the migration implementation is straightforward. However, it is important to ensure the...
Line range hint
607-609: Loose punctuation marks should be corrected.- "version": 3 } ``` + "version": 3 }
Line range hint
637-637: Avoid repetitive phrasing to enhance readability.- ...tation of the Session Group feature, we need to handle the `sessionGroups` data during ... + ...tation of the Session Group feature, it's necessary to manage the `sessionGroups` data during ...
Line range hint
709-709: Rephrase to avoid repetitive sentence beginnings.- This approach ensures that users' Session Group data is correctly handled during the import and export process. + This method guarantees that users' Session Group data is correctly handled during the import and export process.
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (4)
- contributing/Basic/Feature-Development.md (3 hunks)
- contributing/Basic/Feature-Development.zh-CN.md (1 hunks)
- contributing/Basic/Intro.md (2 hunks)
- contributing/Basic/Intro.zh-CN.md (1 hunks)
Additional Context Used
LanguageTool (13)
contributing/Basic/Feature-Development.md (7)
Near line 465: As an alternative to the over-used intensifier โveryโ, consider replacing this phrase.
Context: ...en that the migration implementation is very simple. However, it is important to ensure the...
Rule ID: EN_WEAK_ADJECTIVE
Near line 575: โexactly the sameโ might be wordy. Consider a shorter alternative.
Context: ... complete exported data can be restored exactly the same on other devices. The core implementat...
Rule ID: EN_WORDINESS_PREMIUM_EXACTLY_THE_SAME
Near line 607: Loose punctuation mark.
Context: ...ersion": 3 } ``` Where: -exportType: Identifies the type of data being expor...
Rule ID: UNLIKELY_OPENING_PUNCTUATION
Near line 608: Loose punctuation mark.
Context: ...agent,settings, andall. -state`: Stores the actual data, with different ...
Rule ID: UNLIKELY_OPENING_PUNCTUATION
Near line 609: Loose punctuation mark.
Context: ... for differentexportType. -version: Indicates the data version. In the imp...
Rule ID: UNLIKELY_OPENING_PUNCTUATION
Near line 637: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...tation of the Session Group feature, we need to handle thesessionGroupsdata during ...
Rule ID: REP_NEED_TO_VB
Near line 709: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... in the data import and export process. This approach ensures that users' Session Gr...
Rule ID: ENGLISH_WORD_REPEAT_BEGINNING_RULEcontributing/Basic/Feature-Development.zh-CN.md (4)
Near line 204: ๅจ่ฏ็ไฟฎ้ฅฐไธ่ฌไธบโๅฝขๅฎน่ฏ๏ผๅฏ่ฏ๏ผ+ๅฐ+ๅจ่ฏโใๆจ็ๆๆๆฏๅฆๆฏ๏ผๆฐ"ๅฐ"ไผ่ฏ
Context: ...onService็createSessionGroupๆนๆณๆฅๅๅปบๆฐ็ไผ่ฏ็ป๏ผ็ถๅไฝฟ็จrefreshSessions` ๆนๆณๆฅๅทๆฐ session...
Rule ID: wb4
Near line 226: ๅจ่ฏ็ไฟฎ้ฅฐไธ่ฌไธบโๅฝขๅฎน่ฏ๏ผๅฏ่ฏ๏ผ+ๅฐ+ๅจ่ฏโใๆจ็ๆๆๆฏๅฆๆฏ๏ผๆฐ"ๅฐ"ไผ่ฏ
Context: ...ๅ ถไป action ๅฎ็ฐ }); ``` ้่ฟไปฅไธ็ๅฎ็ฐ๏ผๆไปฌๅฏไปฅ็กฎไฟๅจๆทปๅ ๆฐ็ไผ่ฏ็ปๅ๏ผๅบ็จ็็ถๆไผๅๆถๆดๆฐ๏ผไธ็ธๅ ณ็็ปไปถไผๆถๅฐๆๆฐ็็ถๆๅนถ้ๆฐๆธฒๆใ่ฟ็งๆนๅผ...
Rule ID: wb4
Near line 268: ๅจ่ฏ็ไฟฎ้ฅฐไธ่ฌไธบโๅฝขๅฎน่ฏ๏ผๅฏ่ฏ๏ผ+ๅฐ+ๅจ่ฏโใๆจ็ๆๆๆฏๅฆๆฏ๏ผๆๆฐ"ๅฐ"ไผ่ฏ
Context: ...innedSessionsๅsessions็ถๆใ่ฟๅฐไฟ่ฏ็ถๆไธๆๆฐ็ไผ่ฏๆฐๆฎๅๆญฅใ #### getGroupedSessions ไฝฟ็จse...
Rule ID: wb4
Near line 319: ๅจ่ฏ็ไฟฎ้ฅฐไธ่ฌไธบโๅฝขๅฎน่ฏ๏ผๅฏ่ฏ๏ผ+ๅฐ+ๅจ่ฏโใๆจ็ๆๆๆฏๅฆๆฏ๏ผๅบๅฎ"ๅฐ"ไผ่ฏ
Context: ...้ฆๅ ๆฅ่ฏขๆๆไผ่ฏ็ป๏ผ็ถๅๅบไบ่ฟไบ็ป็ ID ๆฅ่ฏข่ชๅฎไนไผ่ฏ็ป๏ผๅๆถๆฅ่ฏข้ป่ฎคๅๅบๅฎ็ไผ่ฏใๆๅ๏ผๅฎ่ฟๅไธไธชๅ ๅซๆๆไผ่ฏๅๆ็ปๅ็ฑป็ไผ่ฏๅ่กจๅฏน่ฑกใ ### sess...
Rule ID: wb4contributing/Basic/Intro.md (1)
Near line 80: The word โotherwiseโ is an adverb that canโt be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...ommended@13.0.0before committing your code, otherwise you will encounter the errorCould not...
Rule ID: THUS_SENTENCEcontributing/Basic/Intro.zh-CN.md (1)
Near line 111: ๅจ่ฏ็ไฟฎ้ฅฐไธ่ฌไธบโๅฝขๅฎน่ฏ๏ผๅฏ่ฏ๏ผ+ๅฐ+ๅจ่ฏโใๆจ็ๆๆๆฏๅฆๆฏ๏ผ่ฟไธๆญฅ"ๅฐ"ๅธฎๅฉ
Context: ...T) ๅ ๅ ฅ็คพๅบ่ฎจ่ฎบ๏ผๆๅบ้ฎ้ขๆๅไบซไฝ ็็ป้ชใ ๅฆๆไฝ ๆไปปไฝ็้ฎ๏ผๆ่ ้่ฆ่ฟไธๆญฅ็ๅธฎๅฉ๏ผ่ฏทไธ่ฆ็น่ฑซ๏ผ่ฏท้่ฟไธ่ฟฐๆธ ้ไธๆไปฌ่็ณปใ
Rule ID: wb4
Markdownlint (9)
contributing/Basic/Feature-Development.md (4)
70: null
Blank line inside blockquote
391: null
Fenced code blocks should have a language specified
522: null
Fenced code blocks should have a language specified
120: null
Images should have alternate text (alt text)contributing/Basic/Feature-Development.zh-CN.md (3)
70: null
Blank line inside blockquote
391: null
Fenced code blocks should have a language specified
120: null
Images should have alternate text (alt text)contributing/Basic/Intro.md (1)
5: Expected: h2; Actual: h4
Heading levels should only increment by one level at a timecontributing/Basic/Intro.zh-CN.md (1)
5: Expected: h2; Actual: h4
Heading levels should only increment by one level at a time
Additional comments not posted (1)
contributing/Basic/Feature-Development.md (1)
7-12: Renumbered sections improve document navigation.
Codecov ReportAll modified and coverable lines are covered by tests โ
Additional details and impacted files@@ Coverage Diff @@
## main #2669 +/- ##
========================================
Coverage 94.04% 94.04%
========================================
Files 356 356
Lines 20567 20567
Branches 2458 1575 -883
========================================
Hits 19342 19342
Misses 1225 1225 โ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Actionable comments posted: 4
Outside diff range and nitpick comments (3)
contributing/Basic/Intro.zh-CN.md (1)
Line range hint
5-5: Adjust heading levels for consistency.- #### TOC + ## TOCcontributing/Basic/Feature-Development.zh-CN.md (2)
Line range hint
204-204: Correct the adverbial usage in Chinese for clarity.- ๅๅปบๆฐ็ไผ่ฏ็ป + ๅๅปบๆฐๅฐไผ่ฏ็ป - ๆทปๅ ๆฐ็ไผ่ฏ็ปๅ + ๆทปๅ ๆฐๅฐไผ่ฏ็ปๅ - ็ถๆไธๆๆฐ็ไผ่ฏๆฐๆฎๅๆญฅ + ็ถๆไธๆๆฐๅฐไผ่ฏๆฐๆฎๅๆญฅ - ๅๆถๆฅ่ฏข้ป่ฎคๅๅบๅฎ็ไผ่ฏ + ๅๆถๆฅ่ฏข้ป่ฎคๅๅบๅฎๅฐไผ่ฏAlso applies to: 226-226, 268-268, 319-319
Line range hint
391-391: Specify the language for code blocks to enable syntax highlighting.- ```tsx + ```tsx
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (4)
- contributing/Basic/Feature-Development.md (5 hunks)
- contributing/Basic/Feature-Development.zh-CN.md (4 hunks)
- contributing/Basic/Intro.md (2 hunks)
- contributing/Basic/Intro.zh-CN.md (1 hunks)
Additional Context Used
Markdownlint (9)
contributing/Basic/Feature-Development.md (4)
70: null
Blank line inside blockquote
391: null
Fenced code blocks should have a language specified
522: null
Fenced code blocks should have a language specified
120: null
Images should have alternate text (alt text)contributing/Basic/Feature-Development.zh-CN.md (3)
70: null
Blank line inside blockquote
391: null
Fenced code blocks should have a language specified
120: null
Images should have alternate text (alt text)contributing/Basic/Intro.md (1)
5: Expected: h2; Actual: h4
Heading levels should only increment by one level at a timecontributing/Basic/Intro.zh-CN.md (1)
5: Expected: h2; Actual: h4
Heading levels should only increment by one level at a time
Additional comments not posted (5)
contributing/Basic/Feature-Development.md (5)
Line range hint
14-27: The updates to the database schema and the addition of thesessionGroupstable are well-documented and clear.
Line range hint
122-179: The implementation details for theSessionGroupModelandSessionServiceare clear and adhere to good coding practices.
Line range hint
179-354: The updates to the frontend data flow and store implementation are comprehensive and provide a good example of effective state management.
Line range hint
354-573: The UI implementation and action binding in theCreateGroupModalcomponent are correctly done and well-documented.
Line range hint
573-709: The data migration strategy is comprehensive, covering both configuration files and database migrations. The implementation is well-documented.
| @@ -1,22 +1,26 @@ | |||
| # Technical Development Getting Started Guide | |||
|
|
|||
| Welcome to the LobeChat technical development getting started guide. LobeChat is an AI conversation application built on the Next.js framework, which integrates a series of technology stacks to achieve diverse functions and features. This guide will provide a detailed introduction to the main technical components of LobeChat and how to configure and use these technologies in your development environment. | |||
| Welcome to the LobeChat Technical Development Getting Started Guide. LobeChat is an AI conversation application built on the Next.js framework, incorporating a range of technology stacks to achieve diverse functionalities and features. This guide will detail the main technical components of LobeChat and how to configure and use these technologies in your development environment. | |||
|
|
|||
| #### TOC | |||
There was a problem hiding this comment.
Adjust heading levels for consistency.
- #### TOC
+ ## TOCCommittable suggestion
โผ๏ธ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| #### TOC | |
| ## TOC |
| @@ -119,7 +119,7 @@ export class LocalDB extends Dexie { | |||
|
|
|||
|  | |||
There was a problem hiding this comment.
Add alternative text to images for accessibility.
- 
+ Committable suggestion
โผ๏ธ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
|  | |
|  | |
| +  |
There was a problem hiding this comment.
Actionable comments posted: 4
Outside diff range and nitpick comments (5)
contributing/Basic/Intro.zh-CN.md (1)
Line range hint
5-5: Adjust the heading level for consistency.- #### TOC + ## TOCcontributing/Basic/Feature-Development.zh-CN.md (2)
Line range hint
204-204: Correct the adverbial modifier in the text.- ๅๅปบๆฐ็ไผ่ฏ็ป + ๅๅปบๆฐๅฐไผ่ฏ็ป - ๆทปๅ ๆฐ็ไผ่ฏ็ปๅ + ๆทปๅ ๆฐๅฐไผ่ฏ็ปๅ - ็ถๆไธๆๆฐ็ไผ่ฏๆฐๆฎๅๆญฅ + ็ถๆไธๆๆฐๅฐไผ่ฏๆฐๆฎๅๆญฅ - ๅๆถๆฅ่ฏข้ป่ฎคๅๅบๅฎ็ไผ่ฏ + ๅๆถๆฅ่ฏข้ป่ฎคๅๅบๅฎๅฐไผ่ฏAlso applies to: 226-226, 268-268, 319-319
Line range hint
391-391: Specify the language for code blocks.- ```tsx + ```tsxcontributing/Basic/Feature-Development.md (2)
Line range hint
465-465: Consider replacing "very simple" with "straightforward" for a more professional tone.- ...en that the migration implementation is very simple. However, it is important to ensure the... + ...en that the migration implementation is straightforward. However, it is important to ensure the...
Line range hint
391-391: Specify the language for code blocks to enable syntax highlighting.- ```ts + ```typescriptAlso applies to: 522-522
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (4)
- contributing/Basic/Feature-Development.md (5 hunks)
- contributing/Basic/Feature-Development.zh-CN.md (4 hunks)
- contributing/Basic/Intro.md (2 hunks)
- contributing/Basic/Intro.zh-CN.md (1 hunks)
Additional Context Used
Markdownlint (9)
contributing/Basic/Feature-Development.md (4)
70: null
Blank line inside blockquote
391: null
Fenced code blocks should have a language specified
522: null
Fenced code blocks should have a language specified
120: null
Images should have alternate text (alt text)contributing/Basic/Feature-Development.zh-CN.md (3)
70: null
Blank line inside blockquote
391: null
Fenced code blocks should have a language specified
120: null
Images should have alternate text (alt text)contributing/Basic/Intro.md (1)
5: Expected: h2; Actual: h4
Heading levels should only increment by one level at a timecontributing/Basic/Intro.zh-CN.md (1)
5: Expected: h2; Actual: h4
Heading levels should only increment by one level at a time
Additional comments not posted (3)
contributing/Basic/Intro.md (1)
5-5: Adjust the heading level for consistency.- #### TOC + ## TOCLikely invalid or redundant comment.
contributing/Basic/Feature-Development.zh-CN.md (1)
120-120: Add alternative text to images for accessibility.-  + Likely invalid or redundant comment.
contributing/Basic/Feature-Development.md (1)
575-575: Consider rephrasing "exactly the same" to "identically" for conciseness.- ... complete exported data can be restored exactly the same on other devices. The core implementat... + ... complete exported data can be restored identically on other devices. The core implementat...Likely invalid or redundant comment.
| 1. [Data Model / Database Definition](#1-data-model--database-definition) | ||
| 2. [Service Implementation / Model Implementation](#2-service-implementation--model-implementation) | ||
| 3. [Frontend Data Flow Store Implementation](#3-frontend-data-flow-store-implementation) | ||
| 4. [UI Implementation and Action Binding](#4-ui-implementation-and-action-binding) |
There was a problem hiding this comment.
Update internal links to match the new section headers.
- 1. [Data Model / Database Definition](#1-data-model--database-definition)
- 2. [Service Implementation / Model Implementation](#2-service-implementation--model-implementation)
- 3. [Frontend Data Flow Store Implementation](#3-frontend-data-flow-store-implementation)
- 4. [UI Implementation and Action Binding](#4-ui-implementation-and-action-binding)
+ 1. [Database Section](#1-database-section)
+ 2. [Model and Service Section](#2-model-and-service-section)
+ 3. [Store Action Section](#3-store-action-section)
+ 4. [UI Section](#4-ui-section)Committable suggestion
โผ๏ธ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| 1. [Data Model / Database Definition](#1-data-model--database-definition) | |
| 2. [Service Implementation / Model Implementation](#2-service-implementation--model-implementation) | |
| 3. [Frontend Data Flow Store Implementation](#3-frontend-data-flow-store-implementation) | |
| 4. [UI Implementation and Action Binding](#4-ui-implementation-and-action-binding) | |
| 1. [Database Section](#1-database-section) | |
| 2. [Model and Service Section](#2-model-and-service-section) | |
| 3. [Store Action Section](#3-store-action-section) | |
| 4. [UI Section](#4-ui-section) |
| @@ -119,7 +119,7 @@ As a result, you can now view the `sessionGroups` table in the `LOBE_CHAT_DB` in | |||
|
|
|||
|  | |||
There was a problem hiding this comment.
Add alternate text to the image for accessibility.
- 
+ Committable suggestion
โผ๏ธ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
|  | |
|  | |
| +  |
contributing/Basic/Intro.zh-CN.md
Outdated
| > \[!IMPORTANT]\ | ||
| > ๅฆๆไฝฟ็จ`npm`ๅฎ่ฃ ไพ่ต๏ผ่ฏทๅจๆไบคไปฃ็ ๅ่ฟ่ก`npm run stylelint-config-recommended@13.0.0`๏ผ่ฟๆ ทๅฏไปฅ้ฟๅ ๅบ็ฐ`Could not find "stylelint-config-recommended"`้่ฏฏ | ||
|
|
There was a problem hiding this comment.
Clarify the important note for better understanding.
- > ๅฆๆไฝฟ็จ`npm`ๅฎ่ฃ
ไพ่ต๏ผ่ฏทๅจๆไบคไปฃ็ ๅ่ฟ่ก`npm run stylelint-config-recommended@13.0.0`๏ผ่ฟๆ ทๅฏไปฅ้ฟๅ
ๅบ็ฐ`Could not find "stylelint-config-recommended"`้่ฏฏ
+ > \[!IMPORTANT] ๅฆๆไฝ ไฝฟ็จ `npm` ๅฎ่ฃ
ไพ่ต๏ผ่ฏทๅจๆไบคไปฃ็ ๅ่ฟ่ก `npm run stylelint-config-recommended@13.0.0`ใ่ฟๆ ทๅฏไปฅ้ฟๅ
ๅบ็ฐๆพไธๅฐ `stylelint-config-recommended` ็้่ฏฏใCommittable suggestion
โผ๏ธ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| > \[!IMPORTANT]\ | |
| > ๅฆๆไฝฟ็จ`npm`ๅฎ่ฃ ไพ่ต๏ผ่ฏทๅจๆไบคไปฃ็ ๅ่ฟ่ก`npm run stylelint-config-recommended@13.0.0`๏ผ่ฟๆ ทๅฏไปฅ้ฟๅ ๅบ็ฐ`Could not find "stylelint-config-recommended"`้่ฏฏ | |
| > \[!IMPORTANT] ๅฆๆไฝ ไฝฟ็จ `npm` ๅฎ่ฃ ไพ่ต๏ผ่ฏทๅจๆไบคไปฃ็ ๅ่ฟ่ก `npm run stylelint-config-recommended@13.0.0`ใ่ฟๆ ทๅฏไปฅ้ฟๅ ๅบ็ฐๆพไธๅฐ `stylelint-config-recommended` ็้่ฏฏใ |
contributing/Basic/Intro.md
Outdated
| > \[!IMPORTANT]\ | ||
| > If you are using `npm` to install dependencies, please run `npm run stylelint-config-recommended@13.0.0` before committing your code to avoid the `Could not find "stylelint-config-recommended"` error. | ||
|
|
There was a problem hiding this comment.
Clarify the important note for better understanding.
- > If you are using `npm` to install dependencies, please run `npm run stylelint-config-recommended@13.0.0` before committing your code to avoid the `Could not find "stylelint-config-recommended"` error.
+ > \[!IMPORTANT] If you use `npm` to install dependencies, ensure you run `npm run stylelint-config-recommended@13.0.0` before committing your code to avoid the error `Could not find "stylelint-config-recommended"`.Committable suggestion
โผ๏ธ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| > \[!IMPORTANT]\ | |
| > If you are using `npm` to install dependencies, please run `npm run stylelint-config-recommended@13.0.0` before committing your code to avoid the `Could not find "stylelint-config-recommended"` error. | |
| > \[!IMPORTANT] If you use `npm` to install dependencies, ensure you run `npm run stylelint-config-recommended@13.0.0` before committing your code to avoid the error `Could not find "stylelint-config-recommended"`. |
|
โค๏ธ Great PR @RubuJam โค๏ธ The growth of project is inseparable from user feedback and contribution, thanks for your contribution! If you are interesting with the lobehub developer community, please join our discord and then dm @arvinxx or @canisminor1990. They will invite you to our private developer channel. We are talking about the lobe-chat development or sharing ai newsletter around the world. |
|
๐ This PR is included in version 0.162.2 ๐ The release is available on: Your semantic-release bot ๐ฆ๐ |
* ๐ docs: update docs * ๐ docs: update docs * ๐ docs: update docs
๐ป ๅๆด็ฑปๅ | Change Type
๐ ๅๆด่ฏดๆ | Description of Change
ๆดๆฐ้จๅๆๆกฃ
Update some documents
๐ ่กฅๅ ไฟกๆฏ | Additional Information
Summary by CodeRabbit
Feature-Development.mddocument for improved clarity and navigation.Intro.mdguide, adding sections on local development setup, code style, contribution guidelines, internationalization, and additional resources.Intro.zh-CN.mdregarding thenpm run stylelint-config-recommended@13.0.0command to prevent setup errors.