Repo docs overhaul

Your repository, documented like someone wants to use it. Priced on the founding ladder: the first five engagements are complimentary in exchange for an honest review, the next ten run at founding rates, and standard rates apply once the proof is in.

Start with the free scoping review

Proof: a free sample engagement

We did a full documentation overhaul for free on the public jmpress.js repo (1,485 stars, 70 files, M tier), to the paid-tier standard. Before: a 1,263-byte README with no install, no quickstart, no API reference. After: architecture overview, setup guide, full API reference, plugin docs, troubleshooting. Read the case study and judge the proof yourself.

Pay on acceptance

You do not pay up front. We deliver the docs, you run the acceptance checklist below, and you pay only if every item passes. If anything fails, the revision round is free; if the revision still fails, you owe nothing.

Free scoping review first

Every engagement starts with a free scoping review: 48-hour turnaround, one real page of findings on your repo’s docs. No payment, no account, no call. If the review shows there is nothing worth fixing, we say so and the engagement ends there.

In a hurry: a $250 priority fast-track delivers the same findings document in 24 hours. The $250 is credited in full toward your engagement, or refunded if there is nothing worth fixing.

What you get

1. 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.
2. Docs audit. Every file in docs/ (or equivalent) read against the actual code. Stale, wrong, or missing sections flagged; wrong ones fixed.
3. Missing essentials written. Installation, configuration, and troubleshooting pages, matched to what the code really does.
4. 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.
5. 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).

Pricing

The founding ladder. Each tier is earned by the one before it.

• Founding Circle: the first five engagements are complimentary, in exchange for an honest review.
• Founding Rates: the next ten engagements are $79, in exchange for a testimonial and case-study rights.
• Standard: $149. Quoted in advance, fixed price, paid only on acceptance.

Every engagement is quoted in advance and paid only on acceptance, like everything here.

How it works

1. You send the repo (a link is enough for public repos; a read-only collaborator invite or archive for private ones) and ask for the free scoping review.
2. The free one-page findings document arrives within 48 hours, with your place on the founding ladder confirmed.
3. You confirm. Draft delivered typically within 5 business days as a pull request, or as a markdown bundle if you prefer. More than 10 business days late and the engagement is free (see Pay on acceptance).
4. One revision round included within 7 days of delivery.

Questions at any point: reply to any email about your order.

Intake form (fields)

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.

Pay on acceptance

No payment is taken before delivery. After the draft arrives, run the acceptance checklist. You pay the quoted tier only if every item passes. If an item fails, the revision round is free. If the revision still fails the checklist, the engagement is cancelled and you owe nothing. More than 10 business days late without delivery: the engagement is free.