KERNIT Documentation
Docs generator productization
The generator can become a B2B/API docs product only if project ingestion, OpenAPI ownership, tenant isolation, hosted output, billing, and support boundaries are explicit.
Product Boundary#
| Layer | KERNIT internal docs | External generator product |
|---|---|---|
| Input | Known KERNIT routes, workflows, and product language. | Customer OpenAPI, repo metadata, brand kit, examples, and support policy. |
| Contract owner | KERNIT owns the OpenAPI source. | Customer either uploads OpenAPI or asks KERNIT to derive and maintain it. |
| Output | Static docs in app/src/docs. | Hosted docs, downloadable static bundle, or customer-controlled deploy target. |
| Analytics | Sanitized docs-events route and local insights. | Tenant-scoped event ingestion, dashboard, export, retention, and deletion policy. |
| Billing | Part of KERNIT product operations. | Per project, per build, hosted seat, or API generation usage. |
OpenAPI Handling Options#
- Customer-owned OpenAPI: fastest and safest. KERNIT generates docs, examples, snapshots, and diff gates from their contract.
- KERNIT-assisted OpenAPI: higher value, higher liability. KERNIT infers or repairs the contract, then asks the customer to approve it before generation.
- Runtime-discovered OpenAPI: should stay opt-in because inferred request and response shapes can be wrong without customer review.
Non-negotiable Product Requirements#
- Tenant isolation for source files, generated pages, analytics, and API keys.
- Idempotent generation jobs with build status, errors, and downloadable artifacts.
- Versioned OpenAPI snapshots and diff reports per customer project.
- Hosted-domain controls for canonical URLs, sitemap, robots, and redirects.
- Clear redaction rules: never store API keys, request bodies, uploaded source files, or customer secrets in docs events.
What Not To Sell Yet#
Do not sell fully automatic docs for any arbitrary project as if it is solved. Sell the narrower wedge first: OpenAPI-backed B2B/API docs generation with explicit customer approval for contracts, examples, auth, errors, and release notes.
Was this page useful?Send a lightweight docs feedback event.