Skip to content

Replace the Vite template frontend/README.md with an OpenBot frontend guide #172

Description

@regnull

Goal

Replace frontend/README.md, which is still the stock "React + TypeScript + Vite" template text, with a short guide to OpenBot's frontend.

Context

Nothing in that file describes this project. A newcomer opening frontend/ should learn where things live: src/pages/, src/components/, the ui.tsx primitives and semantic theme tokens, electron/ (main process, preload, app:// scheme), and how to run it (make dev, pnpm test, pnpm lint, pnpm typecheck). The root README has an Electron section; link to it rather than repeating it.

Acceptance criteria

  • The template text is gone
  • A one-screen overview of the directory layout and the dev/test commands
  • Every command and path is checked against the current tree
  • Links to the root README's Desktop app (Electron) section and to CONTRIBUTING.md

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood-first-issueGood for newcomers

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions