Codocly Client Documentation Retainer Setup (Onboarding)

Codocly Client Documentation Retainer Setup (Onboarding)

1. 01

   Import the client repository through 1-Click OAuth on GitHub, GitLab, or Bitbucket, or use ZIP upload for repos the client will not grant OAuth to

   Confirm the auto-detected framework (Codocly recognizes 40+) matches the client's actual stack before generating anything; a misdetected framework corrupts the OpenAPI and C4 output downstream.

2. 02

   Run all four generation types on a staging branch: README, OpenAPI 3.1 reference, C4 architecture guide, and SRE runbook

   Judge each output against what the client currently ships. If the runbook is thin because the repo has no deployment scripts, flag that as a scoping conversation rather than padding the doc.

3. 03

   Connect the Git webhook and open a test pull request to verify continuous sync fires on push

   Watch the central dashboard sync health panel for the commit event. A webhook that fires on push but not on PR merge will silently stale the docs on client release branches.

4. 04

   Map the published docs site to the client's custom branded domain and confirm automated SSL issues cleanly

   Screenshot the live domain with the client's branding for the onboarding record; this is the artifact that justifies the retainer line item at renewal.

5. 05

   Set role-based access so client engineers can view docs without consuming generation quota

   The Team Plan (₹1,499/month, up to 100 docs per month) is the tier where role-based access matters; keep generation rights with agency staff only.

6. 06

   Record the plan tier, monthly doc allowance, and reset date in the client's delivery file

   Pro Plan carries 40 docs per month at ₹799 per user; Team carries 100. Note which tier the client sits on so a heavy sprint does not exhaust the allowance mid-month.

7. 07

   Hand off the Codocly dashboard view and a one-page guide covering how docs regenerate on commit

   Clients who understand that docs update on every push stop filing stale-documentation tickets, which is the main source of retainer friction.