Skip to content

docs: Add FAQ section - #653

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

docs: Add FAQ section#653
meichuanyi wants to merge 1 commit into
project-ryoma:mainfrom
meichuanyi:docs/add-faq-section

Conversation

@meichuanyi

Copy link
Copy Markdown

Add comprehensive FAQ section to help users understand and use Ryoma effectively.

Changes

  • FAQ section inserted before Documentation section
  • Covers common questions about Ryoma features and usage

FAQ Topics

  1. What is Ryoma — AI-powered Data Agent framework overview
  2. Comparison with LangChain/Pandas — feature comparison table
  3. Supported data sources — Snowflake, Postgres, MySQL, BigQuery, files (6 sources)
  4. Supported LLM providers — OpenAI, Anthropic, Gemini, Cohere, Bedrock, Hugging Face, NVIDIA, GPT4All, Qianfan, SageMaker (11 providers)
  5. SQL Agent usage — code examples for natural language queries
  6. Ryoma Lab — web UI features and startup instructions
  7. Processing engines — Spark, Flink support
  8. Installation — pip install instructions
  9. Environment configuration — API key setup
  10. Tech stack — LangChain, Reflex, Arrow, Jupyter AI Magics
  11. Contributing — guidelines and documentation links
  12. License — Apache 2.0 information
  13. Troubleshooting — common issues and solutions
  14. Help resources — GitHub issues, documentation site

Why

Users often have questions about:

  • How Ryoma differs from LangChain or Pandas
  • Which data sources and LLM providers are supported
  • How to use the SQL Agent with natural language
  • How to start Ryoma Lab web UI
  • Troubleshooting connection and configuration issues

Adding FAQ improves user experience and reduces support burden.

Checklist

  • README.md updated
  • FAQ section placed logically (before Documentation)
  • Code examples verified
  • All links verified
  • Markdown formatting correct

Add comprehensive FAQ section covering:
- What is Ryoma (AI-powered Data Agent framework)
- Comparison with LangChain/Pandas
- Supported data sources (Snowflake/Postgres/MySQL/BigQuery/files)
- Supported LLM providers (OpenAI/Anthropic/Gemini/Cohere/AI21/Bedrock/etc.)
- SQL Agent usage examples
- Ryoma Lab web UI
- Processing engines (Spark/Flink)
- Installation and configuration
- Tech stack overview
- Contributing guidelines
- Documentation links
- License information
- Troubleshooting common issues
- Help resources

FAQ inserted before Documentation section for better readability.
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