stacklok / documentation-review

Reviews documentation for factual accuracy

1 views
0 installs

Skill Content

---
name: Documentation review
description: Reviews documentation for factual accuracy
---

# 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](CHECKING.md) on instructions on how to check claims in the docs.

You have some examples on how to fact-check in [EXAMPLES.md](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