Skip to content

docs: add FAQ section for common questions#1656

Open
meichuanyi wants to merge 1 commit into
embabel:mainfrom
meichuanyi:main
Open

docs: add FAQ section for common questions#1656
meichuanyi wants to merge 1 commit into
embabel:mainfrom
meichuanyi:main

Conversation

@meichuanyi
Copy link
Copy Markdown

Summary

Adds a comprehensive FAQ section to README.md covering:

  • Platform concepts: What is Embabel, key differentiators vs other frameworks
  • Installation: Maven dependency, version info
  • Core concepts: Actions, Goals, Conditions, Domain model, Plan
  • Planning: Dynamic replanning, parallelization, OODA loop
  • AI providers: Spring AI integration, supported providers
  • Observability: @Tracked annotation for tracing
  • Integration: Spring Boot compatibility
  • Resources: Documentation, Discord, GitHub Issues

The FAQ provides quick answers to common questions for JVM developers getting started with Embabel.

Checklist

  • Documentation follows project style
  • FAQ covers common questions from README and documentation
  • No code changes, only documentation

@johnsonr
Copy link
Copy Markdown
Contributor

johnsonr commented May 8, 2026

Please sign the commit, thanks.

@alexheifetz
Copy link
Copy Markdown
Contributor

@meichuanyi please refer to https://github.com/embabel/embabel-agent/pull/1656/checks?check_run_id=74760461041 on how to sign the commit. Tnx!

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.

3 participants