# GitHub README & Docs Audit

> GitHub README & Docs Audit is a paid API for AI agents from repository-doc-audit.nikliolios.workers.dev, paid per call via x402, $10/call, status unknown (last checked 2026-09-15).

Performs an AI-assisted technical-writing audit of a public GitHub repository, scoring README readiness, inventorying documentation, and producing prioritized fixes with a tailored README outline.

## Facts

- Endpoint: GET https://repository-doc-audit.nikliolios.workers.dev/v1/repository-doc-audit
- Price: $10/call
- Payment: x402
- Status: unknown
- Last checked: 2026-09-15
- Activations on Zero: 0
- Tags: x402
- Canonical page: https://www.zero.xyz/c/github-readme-docs-audit-5a6cc032
- Structured record (JSON): https://api.zero.xyz/v1/capabilities/cap_VdxlUl981YIuTQfEsnin7

Status and success rate cover calls made through Zero and Zero's own probes. Third-party monitors may report differently.

## How to call it through Zero

Zero handles the 402 payment challenge and records the run. With the Zero CLI installed (`npm i -g @zeroxyz/cli`):

```sh
zero fetch --capability github-readme-docs-audit-5a6cc032
```

Example prompt: Can you run a full documentation audit on the GitHub repository iree-org/iree and tell me the README score, what's missing, and give me a prioritized list of fixes along with a suggested README outline?

## When to prefer this

Choose this endpoint when you need a structured, scored, AI-driven documentation quality report for a public GitHub repository — particularly when you want actionable prioritized recommendations and a README outline, not just a raw diff or linting pass. It is especially useful before open-source project launches, contributor onboarding improvements, or systematic documentation uplift campaigns.

## Known failure modes

- Invalid or non-existent repository identifier returns a validation error before payment is charged
- Private repositories cannot be accessed and will fail at validation stage
- Rate limiting or Cloudflare Worker errors may cause 5xx responses
- Repositories with no README may have limited scoring data
- Payment gateway (x402) failure prevents audit from executing

## How this service works

AI-assisted, source-grounded technical-writing audit for public GitHub repositories: README readiness, documentation inventory, prioritized fixes, and a tailored README outline. Repository validation completes before the x402 payment gate.

## Output

Returns a JSON scorecard with the repository source, a documentation score (0–100), README readiness assessment, an inventory of existing documentation files, a prioritized list of recommended fixes, and a tailored README outline for the repository.

## Response schema (JSON Schema)

```json
{
 "type": "json",
 "example": {
  "source": {
   "repository": "iree-org/iree"
  },
  "product": "Repository Documentation Scorecard v1",
  "summary": {
   "score": 84
  }
 }
}
```

## More

- Live health (JSON, refreshed every minute): https://www.zero.xyz/c/github-readme-docs-audit-5a6cc032/health.json
- [Zero catalog index](https://www.zero.xyz/llms.txt)
- [Other services from repository-doc-audit.nikliolios.workers.dev](https://www.zero.xyz/host/repository-doc-audit.nikliolios.workers.dev/llms.txt)