{"uid":"cap_nkv8APV8_Zro_z2DM7fsT","slug":"github-readme-docs-audit-d5f737ad","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-doc-scorecard","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":"1","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":"$1/call","primary":{"kind":"static","protocol":"x402","network":"base","amountUsd":"1","per":"call","confidence":"exact"},"accepted":[{"kind":"static","protocol":"x402","network":"base","amountUsd":"1","per":"call","confidence":"exact"}]},"paymentMethods":[{"uid":"pm_4_w8fDCp-De-44fHtLj5s","protocol":"x402","methodType":"crypto","chain":"base","mode":"charge","costAmount":"1","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, scoring its README quality, inventorying documentation, and producing prioritized fixes with a tailored README outline.","exampleAgentPrompt":"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?","exampleUseCases":[{"title":"Open source project README checkup","prompt":"Audit the README for my GitHub repo mlflow/mlflow — give me a score, flag what's missing, and tell me what to prioritize fixing so contributors can get started easily."},{"title":"Pre-launch documentation readiness check","prompt":"Before I launch my new open source tool, can you audit the docs for my repo alice/fastqueue and generate a tailored README outline I should follow?"},{"title":"Comparing documentation quality of a dependency","prompt":"I'm evaluating whether to use huggingface/transformers in my project — can you score its GitHub documentation and summarize how complete and contributor-friendly it is?"}],"resultDescription":"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.","failureModes":["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"],"whenToPreferThis":"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.","instructions":null,"reviewSummary":null,"reviewSummaryHighlights":null,"reviewSummaryConcerns":null,"reviewSummaryGeneratedAt":null,"activationCount":0,"lastUsedAt":null,"lastSuccessfullyRanAt":null,"lastHealthCheckAt":"2026-09-15T12:41:31.008Z","isFirstParty":false}