Skip to content

docs: add FAQ section for common questions#69

Open
meichuanyi wants to merge 1 commit intoInteguru-AI:mainfrom
meichuanyi:docs/add-faq-section
Open

docs: add FAQ section for common questions#69
meichuanyi wants to merge 1 commit intoInteguru-AI:mainfrom
meichuanyi:docs/add-faq-section

Conversation

@meichuanyi
Copy link
Copy Markdown

Summary

Add a comprehensive FAQ section to the README to help new users quickly find answers to common questions about Integuru.

Changes

  • Added FAQ section covering:
    • General: What is Integuru, how it works, supported models
    • Setup & Configuration: System requirements, installation steps, API key setup
    • Usage: Capturing browser requests, HAR files, code generation, input variables
    • Troubleshooting: Graph generation failures, code generation errors, 2FA issues, Poetry problems

Motivation

New users often have the same questions about setup, how the agent works, and how to use the tool effectively. A well-structured FAQ section reduces friction and helps users get started faster.

Checklist

  • Content is original and tailored to Integuru's features
  • FAQ covers the most common user questions based on README content
  • Troubleshooting section addresses practical issues
  • Follows the project's contributing guidelines

@CLAassistant
Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@meichuanyi
Copy link
Copy Markdown
Author

@maintainer 请问有空 review 这个 FAQ 文档 PR 吗?感谢!

@meichuanyi
Copy link
Copy Markdown
Author

@maintainer 请问有空 review 这个 FAQ 文档 PR 吗?如有需要修改的地方请告诉我 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants