Uhpenry
Uhpenry Concepts

Showcase Model

In-depth explanation of the Showcase access model.

A Showcase is a display-only access mode for a Project. It is meant for discovery, marketing, documentation, and lightweight collaboration where source artifacts are not downloadable and no collaborator permissions are granted. The Showcase model is intentionally restrictive: it lets owners present work publicly (or to a limited audience) while protecting the code and binaries from mass distribution.


When to use Showcase

  • Public portfolios and case studies where the author wants visibility but not distribution.
  • Early previews for private repos where owners want to show metadata and READMEs without exposing code.
  • Regulatory or license-sensitive projects where downloads must be restricted.

Core Guarantees & Principles

  1. No direct downloads code files, archives, and repository clones are not available from the Showcase view.
  2. Read-only presentation full repository metadata (README, description, tags, screenshots, public files list) is shown, but file contents are redacted or presented as sanitized code snippets where appropriate.
  3. Auditability views and interactions with the Showcase are recorded via Snapgate; owner can analyze who viewed the Showcase and when.
  4. Owner control owners choose whether a project is in Showcase mode, whether it's publicly indexable, and to which audience it is visible.
  5. Safe defaults sensitive files (e.g., .env, keys, secrets) are automatically excluded or redacted when rendering Showcase content.

What Showcase Shows (Typical UI surface)

  • Project headline and short description.
  • Public PID and owner contact/action CTA (e.g., "Request access" / "Buy" / "Follow").
  • README rendered (sanitized HTML).
  • Screenshots, demo GIFs, and video embed support.
  • Public file tree with redaction rules (see below) or a curated list of public assets.
  • Short code snippets or examples (sanitized and truncated by default; full file requires conversion to Standard access).
  • Metadata: license, tags, version, last updated, languages, size estimates (no direct file contents link).
  • Interaction affordances: star/like, share button (copies PID + URL).

The Showcase model provides a safe, controlled, and public-facing view of a project, allowing owners to highlight work, attract attention, and share information without exposing source code or granting collaborator privileges. By combining **read-only presentation, and redacted content, it ensures that the project remains **protected, and under the owner's full control**.

In essence, Showcase balances visibility with security, making it ideal for portfolios, demos, and regulated projects where discovery matters but unrestricted access does not. It offers a lightweight, low-risk way to present projects, while maintaining Uhpenry's broader guarantees of traceability, auditability, and owner-respected access control.

Note: This guide is living documentation. We welcome contributions and corrections via GitHub or support@uhpenry.com.