{"uid":"cap_VdxlUl981YIuTQfEsnin7","slug":"github-readme-docs-audit-5a6cc032","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-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_ZsTgNWIyvCEfrp8sb-_mV","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, scoring README readiness, inventorying documentation, and producing prioritized fixes with a tailored README outline.","exampleAgentPrompt":"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?","exampleUseCases":[{"title":"Open source repo launch readiness check","prompt":"I'm about to publish my open source project at pytorch/torchdynamo — can you audit the README and docs, give me a quality score, and tell me exactly what to fix before I announce it?"},{"title":"Contributor onboarding docs review","prompt":"Our repo at hashicorp/terraform-cdk has been getting complaints that the docs are confusing — can you do a full documentation audit and give me a prioritized list of what to improve for new contributors?"},{"title":"README outline generation for new project","prompt":"I just created a new repo at myorg/my-new-library and the README is basically empty — can you audit it, score it, and generate a tailored README outline I should follow to get it up to standard?"}],"resultDescription":"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.","failureModes":["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"],"whenToPreferThis":"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.","instructions":null,"reviewSummary":null,"reviewSummaryHighlights":null,"reviewSummaryConcerns":null,"reviewSummaryGeneratedAt":null,"activationCount":0,"lastUsedAt":null,"lastSuccessfullyRanAt":null,"lastHealthCheckAt":"2026-09-15T12:31:03.472Z","isFirstParty":false}