API डॉक्स लेखक किट

API landing page: what it does, OpenAPI and Arazzo descriptions, base URLs, auth in 3 steps, first request, key resources, errors, limits, next steps

SDK landing page: supported-languages matrix, install, auth and config, first call, errors, retries and timeouts, pagination, logging, versioning and support policy

Quickstart page: time-to-first-success target, prerequisites table, three steps with expected output, verify, clean-up, troubleshooting

Diátaxis tutorial – learning goals, prerequisites, numbered lessons with visible results, checkpoints, troubleshooting

Goal-oriented how-to guide: prerequisites table, numbered steps with checks, verification, variations, failure table, worked example

One REST endpoint: auth, parameter tables, request example, responses per status, RFC 9457 errors, limits, idempotency, paging, deprecation headers

Diátaxis reference page – neutral, consistently structured entries for functions, types, errors and constants

Understanding-oriented explanation: idea in brief, context, mechanism diagram, alternatives considered, trade-offs, misconceptions, worked example

Developer guide: setup, auth, multi-language quick start, errors, pagination, rate limits, webhooks, sandbox, OpenAPI/Arazzo/Overlay descriptions, versioning

Dated per-version API change log: additive, behavioural and breaking classes, affected operations, OpenAPI diff links, Deprecation and Sunset values, SDK versions

Customer-facing deprecation and sunset notice: affected users, dates, replacement, migration steps, usage detection, Deprecation and Sunset headers, email and changelog variants

Upgrade/migration guide – who is affected, breaking changes table, timeline, checklist, steps, before/after code, rollback

Troubleshooting guide: diagnostic first steps, symptom index, decision steps per problem with verification, data to collect before contacting support, known issues link

llms.txt site index for language models: H1, summary, link-list sections, Optional section, llms-full.txt, .md page mirrors, rel alternate/describedby discovery