Skip to content

docs: Add FAQ section for common questions#1677

Open
meichuanyi wants to merge 1 commit into
embabel:mainfrom
meichuanyi:docs/add-faq-section
Open

docs: Add FAQ section for common questions#1677
meichuanyi wants to merge 1 commit into
embabel:mainfrom
meichuanyi:docs/add-faq-section

Conversation

@meichuanyi
Copy link
Copy Markdown

Summary

This PR adds a comprehensive FAQ section to help users quickly understand Embabel Agent Framework concepts and common questions.

Changes

  • Added FAQ.md covering:
    • What is Embabel and how it differs from other frameworks
    • Core concepts (Actions, Goals, Conditions, Domain Model, Plan)
    • Planning (GOAP, Utility AI, Replanning)
    • Execution modes (Focused, Closed, Open)
    • Installation and Quick Start
    • Writing agents in Java and Kotlin
    • LLM integration and providers
    • Testing strategies
    • Domain model benefits
    • Troubleshooting common issues

Benefits

  • Helps new users understand JVM-native agent development
  • Reduces confusion about GOAP planning vs other approaches
  • Provides clear guidance on agent annotations
  • Offers troubleshooting tips for common problems

Checklist

  • Documentation update only
  • No code changes
  • Content reviewed for accuracy

@alexheifetz
Copy link
Copy Markdown
Contributor

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