{"sample":true,"charged":false,"fixedRepository":"iree-org/iree","notice":"Free example only. This route always returns the fixed IREE report and does not accept another repository.","product":"Repository Documentation Readiness Audit v1","generatedAt":"2026-09-15T11:54:07.215Z","source":{"repository":"iree-org/iree","url":"https://github.com/iree-org/iree","defaultBranch":"main","lastPush":"2026-09-15T11:49:17Z","treeWasTruncated":false},"summary":{"score":53,"possible":100,"verdict":"Partial documentation; new-user friction is likely","primaryGap":"Add a five-minute quick start with expected output"},"scorecard":[{"category":"Orientation","possible":15,"earned":15,"evidence":["PASS: root README is present","PASS: repository description states the project purpose","PASS: README provides enough opening context for a new reader"]},{"category":"Installation","possible":20,"earned":8,"evidence":["GAP: installation or setup guidance is discoverable","PASS: root build manifest is present (CMakeLists.txt)","PASS: commands can be inferred from versioned project metadata"]},{"category":"First success","possible":20,"earned":3,"evidence":["GAP: a quick-start path is explicitly labeled","GAP: usage or examples are documented","PASS: versioned example or sample files exist"]},{"category":"Reference","possible":15,"earned":3,"evidence":["GAP: configuration or options are documented","GAP: API, CLI, or reference material is discoverable","PASS: documentation extends beyond a single README"]},{"category":"Contribution","possible":10,"earned":10,"evidence":["PASS: contribution instructions are present","PASS: development or test workflow is documented"]},{"category":"Maintenance","possible":10,"earned":6,"evidence":["GAP: troubleshooting guidance exists","PASS: change history is versioned","PASS: issue-reporting templates are configured"]},{"category":"Trust","possible":10,"earned":8,"evidence":["PASS: license is declared (Apache-2.0)","GAP: code of conduct is present","PASS: repository is an original project rather than a fork"]}],"inventory":{"readmeCharacters":7040,"readmeHeadings":["IREE: Intermediate Representation Execution Environment","Project news","Project status","Release status","Build status","Nightly build status","Communication channels","Related project channels","Architecture overview","Presentations and talks","License"],"documentationFilesSampled":["CONTRIBUTING.md","README.md","build_tools/bin/README.md","build_tools/cmake/README.md","build_tools/cmake/presets/README.md","build_tools/github_actions/README.md","build_tools/llvm/README.md","build_tools/pkgci/README.md","build_tools/pkgci/bisect/README.md","build_tools/python_deploy/README.md","build_tools/third_party/cuda/README.md","build_tools/third_party/tracy/README.md","compiler/README.md","compiler/bindings/c/README.md","compiler/bindings/python/iree/compiler/README.md","compiler/bindings/python/test/tools/README.md","compiler/bindings/python/test/tools/testdata/README.md","compiler/plugins/input/README.md","compiler/plugins/input/Torch/torch-mlir-dialects/README.md","compiler/plugins/input/Torch/torch-mlir/README.md","compiler/plugins/target/README.md","compiler/src/iree/compiler/API/README.md","compiler/src/iree/compiler/ConstEval/README.md","compiler/src/iree/compiler/Dialect/VMVX/README.md","compiler/src/iree/compiler/Modules/README.md","compiler/src/iree/compiler/Pipelines/README.md","compiler/src/iree/compiler/PluginAPI/README.md","compiler/src/iree/compiler/README.md","compiler/src/iree/compiler/Transforms/README.md","docs/.markdownlint.yml","docs/api_docs","docs/api_docs/python","docs/api_docs/python/.gitignore","docs/api_docs/python/.readthedocs.yaml","docs/api_docs/python/Makefile","docs/api_docs/python/README.md","docs/api_docs/python/_static","docs/api_docs/python/_static/custom.css","docs/api_docs/python/compiler","docs/api_docs/python/compiler/api.rst","docs/api_docs/python/compiler/build.rst","docs/api_docs/python/compiler/index.rst","docs/api_docs/python/compiler/iree_input_dialect.rst","docs/api_docs/python/compiler/mlir.rst","docs/api_docs/python/compiler/mlir_dialects.rst","docs/api_docs/python/compiler/tools.rst","docs/api_docs/python/conf.py","docs/api_docs/python/index.rst","docs/api_docs/python/requirements.txt","docs/api_docs/python/runtime.rst","docs/website","docs/website/.gitignore","docs/website/README.md","docs/website/custom_edit_url.py","docs/website/docs","docs/website/docs/CNAME","docs/website/docs/assets","docs/website/docs/assets/images","docs/website/docs/assets/images/.gitignore","docs/website/docs/assets/images/IREE_Logo_Icon_Color.svg"],"rootManifest":"CMakeLists.txt","hasExamples":true,"hasContributingGuide":true,"hasTroubleshooting":false,"hasLicense":true,"hasIssueTemplates":true},"inferredCommands":["cmake -S . -B build","cmake --build build","ctest --test-dir build"],"prioritizedChanges":[{"priority":1,"change":"Add a five-minute quick start with expected output","why":"Readers cannot verify success without one complete happy path.","acceptanceCheck":"A new user can copy the commands and compare the result with documented output."},{"priority":2,"change":"Document prerequisites and installation separately","why":"Environment assumptions are the most common onboarding failure point.","acceptanceCheck":"Runtime versions, external dependencies, and one install command are explicit."},{"priority":3,"change":"Add a configuration reference with defaults","why":"Users need to distinguish required setup from optional tuning.","acceptanceCheck":"Every documented setting has purpose, required status, default, and safe example."},{"priority":4,"change":"Document the three likeliest setup failures","why":"Short symptom → cause → fix entries prevent repeated issue traffic.","acceptanceCheck":"Each entry includes an observable symptom, likely cause, and verified recovery step."}],"proposedReadmeOutline":"# iree-org/iree\n\nA retargetable MLIR-based machine learning compiler and runtime toolkit.\n\n## Requirements\n\nList supported runtimes, operating systems, and external dependencies.\n\n## Install\n\nGive one copy-pasteable happy path.\n\n## Quick start\n\nShow the smallest working invocation plus expected output.\n\nSuggested command sequence: `cmake -S . -B build` → `cmake --build build` → `ctest --test-dir build`\n\n## Configuration\n\nDocument required and optional settings, defaults, and a safe example.\n\n## Common tasks\n\nCover build, test, lint, and troubleshooting commands verified against the repository.\n\n## Contributing\n\nLink setup, tests, style expectations, and the pull-request process.\n\n## License and support\n\nState the license and where users should ask questions or report bugs.","methodology":["Read the public repository metadata, default-branch tree, README, and one root build manifest directly from GitHub.","Scored seven documented categories with a fixed 100-point rubric; every score line includes its pass/gap evidence.","Inferred commands only from versioned manifests and lockfiles; no command was executed against the repository.","Tree results marked truncated by GitHub are disclosed and may omit files after the API limit."],"disclosure":"AI-assisted, deterministic audit. Source observations come from the named public GitHub repository; recommendations should be reviewed by a maintainer before publication.","followUp":{"service":"Focused repository-documentation sprint: one README, build guide, or onboarding page with a Markdown patch, change log, and one revision.","price":"$15 flat","turnaround":"24 hours","demo":"/v1/example-report","order":"https://ugig.net/gigs/3b152299-ffab-4736-9df9-6b08c81595c3"},"nextSteps":{"auditAnotherRepository":{"preflight":"https://repository-doc-audit.nikliolios.workers.dev/v1/preflight?repo=owner%2Fname","scorecard":"https://repository-doc-audit.nikliolios.workers.dev/v1/repository-doc-scorecard?repo=owner%2Fname","scorecardPrice":"$1.00","fullAudit":"https://repository-doc-audit.nikliolios.workers.dev/v1/repository-doc-audit?repo=owner%2Fname","fullAuditPrice":"$10.00"},"hireDocumentationSprint":{"price":"$15 flat","scope":"One focused README, build guide, or contributor-onboarding patch for a public repository, delivered within 24 hours after funding.","toku":"https://www.toku.agency/services/cmtyews5l0001ia04akntpt4a","ugig":"https://ugig.net/gigs/3b152299-ffab-4736-9df9-6b08c81595c3"}}}