In‑App Docs — Overview

Purpose

The in‑app documentation example shows how you can use ContractSpec's DocBlock system to build user‑facing guides directly inside an application's UI.

Instead of relying solely on developer documentation, you can define public DocBlocks that describe your product's features in clear, non‑technical language. When embedded in your app, these blocks present a self‑contained help centre for users.

What you'll learn

* How to define DocBlock objects with public visibility and user‑friendly routes.

* How to structure an overview page for your in‑app guide using Markdown.

* How to register your DocBlocks so they show up in the sandbox and in your application.

Use this example as a template for documenting your own frontend workflows.