Skip to content

DESIGN.md

Latest commit

 

History

History
113 lines (87 loc) · 3.36 KB

DESIGN.md

File metadata and controls

113 lines (87 loc) · 3.36 KB
Raw
version alpha
name Buzz for Cloudron
description Preserve the unmodified upstream Buzz interface in this package.
colors
primary secondary tertiary neutral background surface on-surface error outline
#8839EF
#CCD0DA
#CCD0DA
#EFF1F5
#EFF1F5
#EFF1F5
#4C4F69
#D20F39
#BCC0CC
typography
body-md label-md
fontFamily fontSize fontWeight lineHeight
Inter Variable
16px
400
1.5
fontFamily fontSize fontWeight lineHeight
Inter Variable
14px
500
1.4
rounded
sm md lg
4px
10px
16px
spacing
unit xs sm md lg
8px
4px
8px
16px
32px
components

Design System: Buzz for Cloudron

1. Overview

This repository packages upstream Buzz and does not create a separate product interface. The image copies the upstream web and administration bundles without modification. Upstream Buzz remains the sole visual and interaction authority.

2. Colors

The recorded light-theme tokens come from the upstream Buzz web bundle at web/src/shared/styles/globals.css. The palette is Catppuccin Latte with a mauve primary accent. Dark-mode tokens also remain entirely upstream-owned.

3. Typography

Upstream Buzz uses Inter Variable with Inter, Avenir Next, Segoe UI, and generic sans-serif fallbacks. This package must not inject fonts or alter the hierarchy.

4. Layout

All page structure, spacing, navigation, and responsive behavior come from the pinned upstream web assets under /srv/buzz/web. Cloudron provides only the reverse proxy and container frame.

5. Elevation and Depth

Use the elevation, borders, and tonal layers compiled into upstream Buzz. The Cloudron package adds no overlays, banners, modals, or navigation surfaces.

6. Shapes

The upstream radius token is 0.625rem. Do not restyle the bundled interface in packaging code.

7. Components

The package owns no visual components. Operator administration is deliberately command-line based through /app/code/buzz-ctl. The public HTTP surface is the unmodified upstream invite and Git-forge bundle.

8. Guidance

Do:

  • Copy pinned upstream web assets without modification.
  • Keep operational messages in Cloudron metadata and the README.
  • Update this document if the package later adds any visual surface.

Do not:

  • Rebrand Buzz or imply that this package is an official Block distribution.
  • Inject Cloudron-specific CSS or JavaScript into upstream assets.
  • Expose secrets, internal health data, or MinIO controls in a browser view.

9. Responsive Behaviour

Responsive behavior belongs to upstream Buzz desktop, mobile, and web clients. The package must preserve WebSocket, media, and static-asset delivery without changing client layout behavior.

10. Publishing Assets

The package icon remains the upstream Buzz mark. media/hero.png is a 1568×523 crop of the privacy-reviewed general-channel screenshot and preserves the unmodified upstream interface. Re-run the screenshot privacy review before replacing it; no private channels, messages, keys, local paths, or account data may appear in Community Apps media.

11. Agent Prompt Guide

When changing packaging, treat the upstream interface as immutable. UI changes belong upstream unless this repository explicitly adopts a separate management surface. If that occurs, define its tokens, accessibility, responsive behavior, and screenshots here in the same change.