{"uid":"cap_P91mgAABd0X4sux1-vXVU","slug":"github-readme-docs-audit-880fdff1","name":"GitHub README & Docs Audit","description":"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.","url":"https://repository-doc-audit.nikliolios.workers.dev/v1/repository-documentation-audit","method":"GET","headers":{},"bodySchema":null,"responseSchema":{"type":"json","example":{"source":{"repository":"iree-org/iree"},"product":"Repository Documentation Scorecard v1","summary":{"score":84}}},"example":null,"exampleRequest":null,"tags":["x402"],"displayCostAmount":"10","displayCostAsset":"USDC","priceDynamic":false,"priceHint":null,"priceStatus":"priced","priceSource":"registry","requiresHandshake":false,"reviewCount":0,"rating":{"score":"0.00","successRate":"0.00","reviews":0,"stars":null,"state":"unrated"},"availabilityStatus":"unknown","priceObserved":null,"sessionDeposit":null,"pricing":{"kind":"static","summary":"$10/call","primary":{"kind":"static","protocol":"x402","network":"base","amountUsd":"10","per":"call","confidence":"exact"},"accepted":[{"kind":"static","protocol":"x402","network":"base","amountUsd":"10","per":"call","confidence":"exact"}]},"paymentMethods":[{"uid":"pm_BNuPeVZqN7zBGj7DP2Lkc","protocol":"x402","methodType":"crypto","chain":"base","mode":"charge","costAmount":"10","costPer":"request","priority":0,"asset":null,"unit":"request","depositMicros":null,"planRef":null}],"brandName":null,"brandSlug":null,"brandBaseUrl":null,"brandDocsUrl":null,"whatItDoes":"Performs an AI-assisted technical-writing audit of a public GitHub repository's README and documentation, returning a readiness score, documentation inventory, prioritized fixes, and a tailored README outline.","exampleAgentPrompt":"Can you run a full documentation audit on the public GitHub repo 'iree-org/iree' and tell me the README readiness score, what's missing, and give me a prioritized list of fixes plus a suggested README outline?","exampleUseCases":[{"title":"Pre-launch open source repo polish","prompt":"I'm about to open-source my project at 'myorg/my-awesome-lib' — can you audit the README and docs and tell me the readiness score and what I need to fix before I announce it?"},{"title":"Evaluating a third-party library's docs","prompt":"Before we adopt 'huggingface/transformers' in our stack, can you audit its GitHub documentation quality and give me a score and summary of any gaps?"},{"title":"Generating a README outline for a new project","prompt":"I just started 'acmecorp/data-pipeline-toolkit' on GitHub and haven't written docs yet — can you audit what's there and give me a tailored README outline to work from?"}],"resultDescription":"Returns a JSON object with a 'Repository Documentation Scorecard v1' including the source repository, an overall score (0–100), README readiness details, a documentation inventory of existing docs, a prioritized list of recommended fixes, and a tailored README outline for the repository.","failureModes":["Invalid or non-existent repository name returns a validation error before payment is charged","Private repositories cannot be audited and will fail at the validation stage","Payment gate ($10 USDC via x402) failure will block the audit from proceeding","Rate limiting or Cloudflare Worker timeout for very large repositories","Repositories with no discernible code content may return low-confidence results"],"whenToPreferThis":"Choose this endpoint when you need a structured, scored, AI-generated audit of a public GitHub repository's README and documentation — especially when you want source-grounded analysis, a documentation inventory, prioritized actionable fixes, and a ready-made README outline all in one call. Prefer this over generic LLM prompting when you want a reproducible scorecard format and repository validation before incurring cost.","instructions":null,"reviewSummary":null,"reviewSummaryHighlights":null,"reviewSummaryConcerns":null,"reviewSummaryGeneratedAt":null,"activationCount":0,"lastUsedAt":null,"lastSuccessfullyRanAt":null,"lastHealthCheckAt":"2026-09-14T06:30:14.574Z","isFirstParty":false}