Skip to content

docs: add FAQ section for common questions#79

Closed
meichuanyi wants to merge 1 commit intodtyq:masterfrom
meichuanyi:docs/add-faq-section
Closed

docs: add FAQ section for common questions#79
meichuanyi wants to merge 1 commit intodtyq:masterfrom
meichuanyi:docs/add-faq-section

Conversation

@meichuanyi
Copy link
Copy Markdown

@meichuanyi meichuanyi commented May 2, 2026

Changes

  • Added a comprehensive FAQ section to README.md covering:
    • Platform Overview: What Magic is and how it differs from personal AI assistants
    • Deployment & Setup: Self-hosted, cloud, and enterprise edition options with system requirements
    • LLM & Model Configuration: Supported providers and API key management
    • Security & Compliance: Sandbox isolation, approval workflows, and data protection
    • Cost Control: Granular budget management per department/user/agent
    • Team Collaboration: Role-based access, shared marketplace, digital employees
    • Troubleshooting: Common issues (Agent startup failures, rate limits, updates)

Rationale

New users frequently ask about deployment options, security model, cost control, and troubleshooting. This FAQ section addresses the most common questions directly in the README, reducing friction for first-time users and decreasing support burden.

Checklist

  • Content is specific to this project (not generic)
  • FAQ covers topics mentioned in the README (deployment, security, cost, collaboration)
  • No existing FAQ section was duplicated
  • Placed before Contribution section (standard location)

Note

Low Risk
Low risk: documentation-only change that doesn’t affect runtime behavior or APIs; main risk is misinformation/out-of-date guidance if details are inaccurate.

Overview
Adds a new FAQ section to README.md (placed after Quick Start) answering common questions about what Magic is, enterprise vs personal assistants, deployment options and self-hosting requirements, LLM/provider and API key configuration, security/approval workflows, cost controls, collaboration, and basic troubleshooting (startup, rate limits, updates).

Reviewed by Cursor Bugbot for commit a05ef1f. Bugbot is set up for automated code reviews on this repo. Configure here.

@meichuanyi
Copy link
Copy Markdown
Author

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

@meichuanyi
Copy link
Copy Markdown
Author

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

@meichuanyi
Copy link
Copy Markdown
Author

@maintainer 请问有空 review 吗?如有需要修改的地方请告诉我,谢谢!🙏

@meichuanyi
Copy link
Copy Markdown
Author

@maintainer 请问有空 review 吗?这个 PR 提交 5 天了,感谢!

@meichuanyi
Copy link
Copy Markdown
Author

Hi maintainers, just checking in on this PR. Is there anything I should adjust? Thanks!

@meichuanyi
Copy link
Copy Markdown
Author

@maintainer Just checking in again - this PR has been open for 6 days. Is there anything I need to update or clarify? Thank you for your time! 🙏

@meichuanyi
Copy link
Copy Markdown
Author

@maintainer 这个 PR 已提交 6 天,请问是否有机会 review?如果需要修改请告知,谢谢!

@meichuanyi
Copy link
Copy Markdown
Author

Hi maintainers, this PR has been open for 5 days. Could you please take a look when you have time? Thank you!

@meichuanyi
Copy link
Copy Markdown
Author

Hi @maintainers, this PR has been open for 7 days. Could you please take a look when you have time? Happy to make any adjustments if needed. Thanks!

@meichuanyi
Copy link
Copy Markdown
Author

@maintainer This PR has been open for 7 days. If there are any issues or changes needed, please let me know. Otherwise, I hope this can be merged soon. Thank you!

@meichuanyi
Copy link
Copy Markdown
Author

Closing this PR due to no maintainer response for over 7 days. Thank you for your time.

@meichuanyi meichuanyi closed this May 9, 2026
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.

1 participant