docs: Add FAQ section#40
Conversation
shreyas-lyzr
left a comment
shreyas-lyzr
left a comment
There was a problem hiding this comment.
Good addition overall — an FAQ section is useful and the structure is clear. Four issues worth fixing before merge: one factual contradiction, one broken code example, one missing structural element, and one documentation accuracy concern. Inline comments below.
| ## License | ||
|
|
||
| This project is licensed under the [MIT License](./LICENSE). | ||
| ## FAQ |
There was a problem hiding this comment.
Missing blank line between the end of the License section and this new heading. The diff shows ## FAQ placed immediately after the license paragraph with no separator. Most Markdown renderers tolerate it, but it is inconsistent with every other top-level section in this file and will look wrong in some parsers. Add a blank line before ## FAQ.
| ## FAQ | |
| ## FAQ |
|
|
||
| - **Documentation** — [GitHub README](https://github.com/open-gitagent/gitagent) | ||
| - **SDK Reference** — README SDK section | ||
| - **Issues** — [GitHub Issues](https://github.com/open-gitagent/gitagent/issues) |
There was a problem hiding this comment.
This contradicts the existing README content. The section immediately above this FAQ (line 831) states the project uses the MIT License, and the repo has a LICENSE file for it. Saying "Gitclaw uses a custom license — check the repository for details" is factually wrong and will confuse users. Either align with what the README already says or update both places consistently.
| - **Issues** — [GitHub Issues](https://github.com/open-gitagent/gitagent/issues) | |
| Gitclaw is licensed under the [MIT License](./LICENSE). |
| if (msg.type === "assistant") console.log("\nDone."); | ||
| } | ||
|
|
||
| // Define custom tools |
There was a problem hiding this comment.
The JSON Schema object passed to tool() is missing the top-level "type": "object" field. The JSON Schema spec requires this for object schemas, and strict validators (including some LLM tool-calling APIs) will reject or misbehave without it. The schema should be:
| // Define custom tools | |
| { type: "object", properties: { query: { type: "string" } }, required: ["query"] }, |
2 participants
Adds a comprehensive FAQ section covering Gitclaw concepts, comparison with Claude Code/Codex/OpenClaw, agent file structure (agent.yaml/SOUL.md/RULES.md/memory/tools/skills/hooks), LLM providers, quick start guide, Local Repo Mode, CLI options, SDK usage, hooks system, license, and help resources.