Documentation Review

Generating Commit Messages

Instructions

1. Read the documentation you are instructed to review 2. Make sure that all claims about how toolhive works are accurate 3. Make sure that all examples are based in how toolhive really works, check for formatting, typos and overall accuracy 4. Make sure that all links point to existing files and the content of the links matches what it should

Fact-checking claims in the documentation

See CHECKING.md on instructions on how to check claims in the docs.

You have some examples on how to fact-check in EXAMPLES.md

Your report

• Do not suggest inline changes
• Present findings and put each into a todo list. The user will then go through them and review manually

Checking documentation claims

When a documentation claims something it is important to check it for accuracy.

When doing that, be proactive in launching agents - when the documentation claims something works certain way, launch @agent-toolhive-expert to provide the fact-checking for you.

When the documentation contains a diagram, such as mermaid, launch an agent to confirm if the flow work this way or not.

When the documentation contains an example of running toolhive, check the arguments and command line options for accuracy and check if the example aligns with what it is supposed to achieve.

Examples of documentation checks

The documentation contains a flow digram

Launch an instance of @agent-toolhive-expert and confirm that the diagram is in line with how the system described in the diagram works.

The documentation contains examples of thv command line

Launch an instance of @agent-toolhive-expert and confirm the command line example for accuracy

The documentation contains Kubernetes manifest

Launch an instance of @agent-toolhive-expert and confirm the manifest aligns with the CRDs

The documentation contains a link to a markdown file

Launch an instance of the Explore agent and confirm the link is valid and points to an existing file