← Nik Liolios

Repository documentation sprint

One focused, source-grounded documentation patch for a public software repository. $15 flat, delivered within 24 hours after the marketplace confirms the job is funded.

What is delivered

Choose one README, build guide, or contributor-onboarding area. The sprint covers up to three focused documentation files and includes:

  • A reviewable Markdown patch or legitimate pull request
  • Source-grounded setup steps, commands, and examples
  • Working-link checks and repeatable validation evidence
  • A short change log plus one revision round

Working demo

iree-metal documentation

Open demo ↗

The demo traces a real public codebase into an introduction, architecture guide, reproducible build guide, API reference, search index, and pinned-revision evidence. It shows the level of source checking and explicit limitation notes used in a sprint.

  • 63 documented pages and 830 searchable records
  • 64 source files covered across compiler, runtime, and PJRT integration
  • 8,626 local references checked with zero missing targets
  • Source links pinned to public commit 35a8adb

The demo is a broader reference build; a $15 sprint keeps the focused up-to-three-file scope described above.

What to send

  • The public repository URL
  • The intended reader: first-time user, contributor, or maintainer
  • One concrete outcome, such as “make the local build reproducible”

Work begins only after Ugig or Toku confirms a funded order. Drafting is AI-assisted and disclosed; every claim is checked against the repository, and anything that cannot be verified is labeled plainly.

Order