Repo Docs Overhaul: $149
Your repository, documented like someone wants to use it.
What you get
- README rewritten from scratch. Problem statement, install, 5-minute quickstart, usage, configuration/API reference, contributing, license. Structured so a new visitor understands the project in 60 seconds.
- Docs audit. Every file in
docs/(or equivalent) read against the actual code. Stale, wrong, or missing sections flagged; wrong ones fixed. - Missing essentials written. Installation, configuration, and troubleshooting pages, up to 5 pages total, matched to what the code really does.
- Every code example executed. Each snippet in the README and docs is run against your repo at its pinned version. Broken examples are fixed, not deleted.
- Navigation and index. If you have a docs folder, you get a working index page and consistent headings so the docs read as one document.
What you do not get
- Code changes beyond what documentation requires (typo-level fixes only).
- Translation into other languages.
- Video walkthroughs or screencasts.
- Marketing copy for launch announcements (that is a separate service).
How it works
- You submit the intake form below and check out through Stripe.
- You grant read access to the repo (a link is enough for public repos; a read-only collaborator invite or archive for private ones).
- Draft delivered typically within 3 business days as a pull request, or as a markdown bundle if you prefer. More than 5 business days late triggers a full refund (see Refunds).
- One revision round included within 7 days of delivery.
Questions at any point: reply to any email about your order.
Price
$149 flat, one repository, one branch. Additional repos or branches quoted separately.
Intake form (fields)
| field | required | notes |
|---|---|---|
| repo_url | yes | public link, or state “private, invite to follow” |
| default_branch | no | defaults to the repo’s default |
| audience | yes | who reads these docs (end users, developers, both) |
| install_targets | yes | OS/package managers your users actually use |
| known_stale | no | docs you already suspect are wrong |
| voice | no | formal, friendly, terse; defaults to plain and direct |
| delivery | no | pull request (default) or markdown bundle |
| yes | delivery and the revision round go here |
No account creation, no calls, no meetings. Everything happens through the form and email.
Acceptance checklist
Before you accept delivery, each of these must be true. If any fail, the revision round covers it at no charge.
- README answers in order: what it is, how to install, how to run the quickstart, where the full docs are.
- Install instructions were tested on a clean checkout at the pinned version.
- Every code snippet in the README and docs runs without modification.
- No documented flag, endpoint, or option contradicts the code.
- Troubleshooting page covers the 5 most likely failure modes for a new user.
- Headings, code fences, and links render correctly (no broken anchors).
- No lorem ipsum, no TODOs, no “coming soon” sections left in the docs.
Every deliverable passes a second-model review against the acceptance checklist before it reaches you.
AI disclosure
This service is produced with AI tooling under a human-owned business (Echelon Luxury Services LLC). Every deliverable passes a second-model review against the acceptance checklist before it reaches you. Read the full AI disclosure page.
Refunds
Full refund if the draft is more than 5 business days late. Revision round first for quality issues; refund if the revision still fails the acceptance checklist. Refunds go through Stripe to the original payment method.