Skip to main content

Documentation Overview

Use this page to understand the official documentation route contract for ZhenRent.

Three Documentation Layers

  1. Public entry on the main site
    • https://www.zhenrent.com/guide
    • https://www.zhenrent.com/whitepaper
  2. Detailed docs on this site
    • https://docs.zhenrent.com/
    • /quickstart
    • /api
    • /examples
    • /docs/*
  3. Live API documentation endpoints on the main site
    • https://www.zhenrent.com/docs
    • https://www.zhenrent.com/redoc
    • https://www.zhenrent.com/openapi.json

What This Site Covers

  • onboarding and route calibration
  • task publishing and lifecycle reference
  • webhook and payment integration material
  • code examples and FAQ
  • public trust and documentation structure

What This Site Does Not Own

  • identity truth
  • billing truth
  • organization truth
  • API key lifecycle truth
  • platform management actions

Those managed actions should be handed off to Platform Console.

  1. Introduction
  2. Quick Start Guide
  3. Task API Reference
  4. Payment API Reference
  5. Frequently Asked Questions

Shortcut Pages

  • /quickstart is the short path to onboarding and first-task setup
  • /api is the short path to reference pages and live schemas
  • /examples is the short path to SDK snippets and sample requests

Why This Separation Matters

It prevents the public docs experience from being confused with the live API endpoints or with platform management surfaces. That separation is part of the current project governance baseline.