Knowledge RAG

Design Knowledge Base

Community-maintained principles reviewed before publication and retrieved as Agent design constraints.

2 published principles / 192 in library

Frontend Implementationapi-reference / openapi

API Reference Endpoint Page Contract

An API endpoint page should combine method/path, auth, parameters, request body, response/error matrix, examples, try-it safety, and mobile schema reading into one executable documentation contract.

An API reference is not complete just because an OpenAPI schema is rendered. It is an operating surface for developers and must support discovery, first calls, auth setup, error recovery, copied examples, try-it safety, and version trust.

96%Frontend Implementationdeveloper-docs / code-block

Developer Docs Code Example and Copy Contract

Code blocks in developer docs must do more than look highlighted: they explain the task, copy safely, provide clear feedback, keep tabs keyboard-operable, and avoid breaking mobile page scrolling.

A code example is a product operation surface. It carries teaching, configuration, API calls, trust, and execution cost, so syntax highlighting, copy, placeholders, tabs, playgrounds, responsiveness, and accessible feedback need one component contract.

96%