Skip to content

Package Documentation

This section provides access to the technical deep-dive documentation for each Hop3 package. Each package keeps its own deep-dive in packages/<package-name>/docs/internals.md; the pages in this directory mirror that content so it is reachable from the main documentation site.

Package Overview

Package Purpose Entry Point Documentation
hop3-server Core platform server hop3-server internals
hop3-cli Command-line interface hop3 / hop internals
hop3-installer Installation toolkit hop3-install, hop3-deploy-server internals
hop3-tui Terminal user interface hop3-tui internals
hop3-testing Testing framework hop3-test internals

Package Relationships

flowchart TD
    server["hop3-server<br/>(core)"]
    server --> cli["hop3-cli<br/>(client)"]
    server --> tui["hop3-tui<br/>(client)"]
    server --> test["hop3-test<br/>(tests)"]
    installer["hop3-installer"] -->|installs| server
    installer -->|installs| cli

Documentation Structure

Each package has:

packages/<package-name>/
├── README.md           # Quick overview, installation, usage
├── docs/
│   └── internals.md    # Technical deep-dive (mirrored here)
└── src/

The pages in this directory mirror each package's internals.md: - hop3-server.md ← packages/hop3-server/docs/internals.md - hop3-cli.md ← packages/hop3-cli/docs/internals.md - etc.