Skip to content

cbuserguide - User Guide Generator

Automated documentation generator for Campaign Brain web applications.

Purpose

Generate automated markdown user guides for web apps by:

  1. Mapping UI components to their related API calls
  2. Mapping screenshot coordinates to underlying UI components
  3. Producing navigable user documentation

Architecture

Uses Playwright and pytest to gather UI/API interaction data, then generates markdown documentation.

Tech Stack

  • Python (nominates pyenv environment)
  • Playwright - Browser automation for screenshots and DOM inspection
  • pytest - Test framework for gathering interaction data
  • FastHTML - Target framework (DOM-based component identification)

Workflow

  1. Data Collection: Crawl web app, capture screenshots, map DOM elements
  2. API Mapping: Correlate UI interactions with API endpoints
  3. Documentation Generation: Produce markdown guides with annotated screenshots