docs: add FAQ section - #1123
meichuanyi wants to merge 1 commit into
Conversation
…roviders, local models, deployment, platforms, fine-tuning, and help resources
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds a detailed FAQ section to the README.md, providing information on LazyLLM's features, comparisons with other frameworks, and deployment options. The review feedback recommends moving the FAQ to the end of the file to preserve the document's flow, removing a redundant installation step to avoid inconsistency, standardizing arrow characters for consistency, and adding a blank line before the Installation header for correct Markdown rendering.
| 5. **Supports basic webs**: such as chat interface and document management interface, etc. | ||
|
|
||
|
|
||
| ## FAQ |
There was a problem hiding this comment.
The FAQ section is currently placed between the feature list and the installation guide. Typically, FAQs are placed at the end of the README to avoid interrupting the flow for users looking for setup instructions. Consider moving this entire block to the end of the file.
|
|
||
| ### How does LazyLLM differ from LangChain or CrewAI? | ||
|
|
||
| - **LazyLLM**: Low-code approach, focuses on rapid prototyping → data feedback → iterative optimization, one-click deployment, cross-platform compatibility |
There was a problem hiding this comment.
Use the ASCII arrow -> instead of the Unicode arrow → to maintain consistency with the terminology used in the introduction (line 16).
| - **LazyLLM**: Low-code approach, focuses on rapid prototyping → data feedback → iterative optimization, one-click deployment, cross-platform compatibility | |
| - **LazyLLM**: Low-code approach, focuses on rapid prototyping -> data feedback -> iterative optimization, one-click deployment, cross-platform compatibility |
| ### How do I install LazyLLM? | ||
|
|
||
| ```bash | ||
| pip install lazyllm | ||
| ``` | ||
|
|
There was a problem hiding this comment.
This installation question is redundant as a dedicated 'Installation' section follows immediately after the FAQ. Additionally, it uses pip while the main section uses pip3. Removing this entry prevents duplication and potential inconsistency.
| - **Documentation**: https://docs.lazyllm.ai/ | ||
| - **Discord**: https://discord.gg/cDSrRycuM6 | ||
| - **GitHub Issues**: https://github.com/LazyAGI/LazyLLM/issues | ||
| ## Installation |
There was a problem hiding this comment.
A blank line is missing before the ## Installation header. Adding it ensures consistent section spacing and proper Markdown rendering.
| ## Installation | |
| ## Installation |
1 participant
Adds a comprehensive FAQ section to help users quickly understand LazyLLM:
This FAQ aims to reduce user confusion and improve the onboarding experience.