Skip to content

User_Interfaces.md

Latest commit

 

History

History
79 lines (64 loc) · 4.47 KB

User_Interfaces.md

File metadata and controls

79 lines (64 loc) · 4.47 KB
Raw

User Interfaces

Purpose

The User_Interfaces subsystem is the set of interchangeable front-ends through which users drive CodeWiki. All three converge on the same underlying pipeline — Code_Analysis_Engine followed by Documentation_Generation_Engine — but serve different workflows:

  1. CLI — the codewiki command-line tool for local, one-shot repository documentation: interactive configuration and credential management, incremental updates (--update / --compare-to), git branch/PR automation, static HTML viewer generation for GitHub Pages, and terminal progress UX.
  2. Frontend_Web_App — a FastAPI web service that accepts GitHub repository URLs, clones and processes them asynchronously through a background worker with job tracking and caching, and serves the generated documentation as browsable HTML.
  3. MCP_Session_Management — stateful session and on-disk workspace management for CodeWiki's MCP server, which exposes analysis and documentation tools to IDE-integrated AI assistants over the Model Context Protocol for interactive, multi-step workflows.

Architecture

flowchart TB
    UserCLI(["Terminal user"]) --> CLI
    UserWeb(["Browser user"]) --> FE
    UserIDE(["IDE AI assistant"]) --> MCP

    subgraph UI["User_Interfaces"]
        subgraph CLI["CLI"]
            CM["ConfigManager<br/>(config + keyring credentials)"]
            DGA["CLIDocumentationGenerator<br/>(pipeline adapter)"]
            GM["GitManager<br/>(branch / PR automation)"]
            HG["HTMLGenerator<br/>(static viewer)"]
            UX["CLILogger / ProgressTracker"]
        end
        subgraph FE["Frontend_Web_App"]
            RT["WebRoutes<br/>(FastAPI endpoints)"]
            BW["BackgroundWorker<br/>(async job queue)"]
            GH["GitHubRepoProcessor"]
            CACHE["CacheManager"]
        end
        subgraph MCP["MCP_Session_Management"]
            SS["SessionStore / SessionState"]
            WS["SessionWorkspace<br/>(on-disk isolation)"]
        end
    end

    DGA --> Pipeline["Code_Analysis_Engine →<br/>Documentation_Generation_Engine"]
    BW --> Pipeline
    SS --> Pipeline

    Pipeline --> MD["Markdown docs + module_tree.json"]
    MD --> HG
    MD --> RT
    MD --> WS

    click CM "CLI_Configuration.md"
    click DGA "CLI_Documentation_Generation.md"
    click GM "CLI_Git_Integration.md"
    click HG "CLI_HTML_Viewer.md"
    click UX "CLI_Utilities.md"
    click RT "Frontend_Web_App_web_routes.md"
    click BW "Frontend_Web_App_job_processing.md"
    click GH "Frontend_Web_App_github_config.md"
    click SS "MCP_Session_Management.md"
    click WS "MCP_Session_Management.md"
    click Pipeline "Code_Analysis_Engine.md"
Loading

Key design decisions:

  • Thin front-ends, shared backend. Each interface only handles its own input/output concerns (argument parsing, HTTP, MCP protocol); documentation work is always delegated to the shared pipeline, so behavior stays consistent across entry points.
  • Different execution models. The CLI runs synchronously in-process with terminal progress bars; the web app decouples request handling from processing via BackgroundWorker and job-status polling; the MCP server holds long-lived sessions whose state and artifacts live in isolated on-disk workspaces.
  • Output tailored per audience. The CLI can emit a self-contained GitHub Pages viewer (index.html), the web app renders docs server-side for browsing, and the MCP server returns structured results for agent consumption.

Modules

Module Responsibility Documentation
CLI Local command-line generation: configuration, git integration, HTML viewer, terminal UX CLI.md
Frontend_Web_App FastAPI service: GitHub repo submission, async job processing, caching, HTML rendering Frontend_Web_App.md
MCP_Session_Management Stateful sessions and workspaces for the MCP server / IDE agents MCP_Session_Management.md

Related Modules