Skip to content

docs: Add FAQ section for user guidance#35

Open
meichuanyi wants to merge 2 commits intoopen-gitagent:mainfrom
meichuanyi:docs/add-faq
Open

docs: Add FAQ section for user guidance#35
meichuanyi wants to merge 2 commits intoopen-gitagent:mainfrom
meichuanyi:docs/add-faq

Conversation

@meichuanyi
Copy link
Copy Markdown

Summary

Adds a comprehensive FAQ section to the README to help users understand Gitclaw and troubleshoot common issues.

Changes

  • Added FAQ section covering:
    • General: What is Gitclaw, agents-as-repos concept, differentiation
    • Installation: Requirements, API key setup, LLM providers
    • Core Concepts: SDK usage, local repo mode sessions, hooks
    • Development: Custom tools, skills, telemetry
    • Troubleshooting: Common issues and debugging tips

Checklist

  • Documentation is clear and helpful
  • No breaking changes to existing content
  • FAQ content based on README and project documentation

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