# 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, $1/call, status unknown (last checked 2026-09-15).

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

## Facts

- Endpoint: GET https://repository-doc-audit.nikliolios.workers.dev/v1/repository-doc-scorecard
- Price: $1/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-d5f737ad
- Structured record (JSON): https://api.zero.xyz/v1/capabilities/cap_nkv8APV8_Zro_z2DM7fsT

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-d5f737ad
```

Example prompt: Can you run a full documentation audit on the GitHub repo iree-org/iree and tell me the README score, what docs are missing, and what I should fix first?

## When to prefer this

Choose this endpoint when you need a structured, scored, AI-generated audit of a public GitHub repository's documentation quality — especially for README readiness, documentation gap analysis, and actionable writing improvements. It is purpose-built for technical writers, open source maintainers, and developer-tool evaluators who want a quantified score and prioritized fix list rather than raw file listings or generic code analysis.

## Known failure modes

- Invalid or non-existent repository slug returns a validation error before payment is charged
- Private repositories are inaccessible and will fail with an authorization or not-found error
- Malformed request missing the repository parameter returns a 400-level error
- Payment gate (x402) failure prevents the audit from executing if USDC payment is not completed
- Rate limiting or Cloudflare Worker timeouts may occur for very large repositories

## 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 object containing the source repository slug, a product label ('Repository Documentation Scorecard v1'), a numeric documentation score (0–100), a README readiness assessment, an inventory of existing documentation files, a prioritized list of fixes or gaps, 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-d5f737ad/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)