Skip to content

docs: add FAQ section#29

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

docs: add FAQ section#29
meichuanyi wants to merge 1 commit into
AgnetLabs:mainfrom
meichuanyi:docs/add-faq

Conversation

@meichuanyi
Copy link
Copy Markdown

Changes

  • Added a comprehensive FAQ section to the README covering:
    • General: What Laddr is, how it differs from LangGraph/CrewAI, license
    • Setup & Configuration: Installation, system requirements, Docker usage
    • Architecture: Two operating modes, agent communication, dashboard
    • Scalability: Horizontal scaling, agent delegation
    • Observability: Tracing options, metrics
    • Troubleshooting: Redis, agent startup, dashboard, batch jobs

Rationale

The README covers features extensively but lacks a quick-reference FAQ section. This addition helps new users quickly find answers to common questions about setup, architecture decisions, and troubleshooting without digging through the full documentation.

Checklist

  • Documentation only change (README.md)
  • FAQ content is specific to Laddr's features and architecture
  • No breaking changes

@meichuanyi
Copy link
Copy Markdown
Author

Hi! Just checking in on this PR. The FAQ section adds value for new users who have common questions about Laddr. Happy to make any adjustments if needed. Thanks! 🙏

@meichuanyi
Copy link
Copy Markdown
Author

@maintainer 请问有空 review 这个文档 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.

1 participant