Skip to content

docs: add FAQ section for common questions#2867

Open
meichuanyi wants to merge 1 commit intoModelEngine-Group:mainfrom
meichuanyi:docs/add-faq-section
Open

docs: add FAQ section for common questions#2867
meichuanyi wants to merge 1 commit intoModelEngine-Group:mainfrom
meichuanyi:docs/add-faq-section

Conversation

@meichuanyi
Copy link
Copy Markdown

Summary

Add a Frequently Asked Questions (FAQ) section to the README to help new users quickly find answers to common questions about Nexent.

Changes

  • Added FAQ section covering:
    • What is Nexent and Harness Engineering
    • System requirements
    • Deployment guide (Docker Compose)
    • Supported LLM providers
    • Custom tool integration via MCP
    • Knowledge base functionality
    • Multimodal input support
    • Community resources

Motivation

New users often have similar questions about Nexent's core concepts (Harness Engineering), deployment requirements, LLM provider support, and how to integrate custom tools. This FAQ section addresses the most common questions directly in the README, reducing friction for new contributors and users.

Checklist

  • Content is accurate and aligned with project documentation
  • Follows the project's commit message convention (docs: prefix)
  • FAQ entries are specific to Nexent's features and use cases

@meichuanyi
Copy link
Copy Markdown
Author

Hi! Just following up on this documentation PR. Would love to hear your thoughts when you have a moment. Thanks! 🙏

@meichuanyi
Copy link
Copy Markdown
Author

Hi! Just following up on this PR. Would love to hear your thoughts on the FAQ section. Let me know if any changes are needed! 👋

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