Skip to content

Package Documentation

This section provides access to the technical deep-dive documentation for each Hop3 package. The documentation files live in each package's docs/ directory; this directory contains symlinks to those files for convenient access from the main documentation.

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 internals
hop3-tui Terminal user interface hop3-tui internals
hop3-testing Testing framework hop3-test internals

Package Relationships

                    ┌─────────────┐
                    │ hop3-server │
                    │   (core)    │
                    └──────┬──────┘
                           │
              ┌────────────┼────────────┐
              │            │            │
              ▼            ▼            ▼
        ┌──────────┐ ┌──────────┐ ┌──────────┐
        │ hop3-cli │ │ hop3-tui │ │hop3-test │
        │ (client) │ │ (client) │ │ (tests)  │
        └──────────┘ └──────────┘ └──────────┘

        ┌───────────────┐
        │hop3-installer │  (installs server + cli)
        └───────────────┘

Documentation Structure

Each package has:

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

The symlinks in this directory point to: - hop3-server.md → packages/hop3-server/docs/internals.md - hop3-cli.md → packages/hop3-cli/docs/internals.md - etc.