# Neith User Guide

This guide covers the user-facing Neith surfaces that are currently implemented
in the repository for Phase 52.

## What Neith Provides Today

The implemented Neith footprint is still narrower than the long-range Neith
plan. Today, the user-facing surfaces are:

- `@neith/release` for release orchestration, artifact publishing, platform
  distribution, and rollout/update control
- `@neith/linux` for the self-hostable Neith Linux platform, including ISO
  images, update flows, rollback support, and sovereign package infrastructure

`@neith/qa` is part of the implemented Neith footprint, but it is an internal
certification package rather than a user-facing product surface.

## Choosing The Right Guide

- Use the [Neith Release User Guide](./release/user-guide.md) if you are a
  release manager, QA lead, operations owner, or partner team preparing releases
  and distribution channels.
- Use the [Neith Linux User Guide](./linux/user-guide.md) if you are installing,
  booting, updating, recovering, or operating a Neith Linux system.

## Quick Start

### Release Operations

1. Define the target version and release train.
2. Generate the release plan, artifacts, integrity metadata, and rollout
   strategy.
3. Publish only the distribution channels needed for the target audience.
4. Validate accessibility, performance, and rollback readiness before signoff.

### Neith Linux

1. Build or obtain the target ISO image.
2. Install Neith Linux on the intended workstation or validation host.
3. Boot into the base system and confirm required services/packages are
   available.
4. Use the update and rollback flows to validate operational recovery before
   broad adoption.

## Supported User Journeys

### Release And Distribution

Neith currently supports user-facing flows for:

- stable releases, beta programs, early access, hotfixes, and security releases
- native package and installer publication
- web, Docker, marketplace, and enterprise distribution
- checksum/signature verification and staged rollout control
- auto-update, delta-update, and rollback-aware release delivery

### Self-Hosted Platform Usage

Neith Linux currently supports user-facing flows for:

- bootable full, minimal, and recovery images
- workstation/service module composition
- sovereign package and overlay management
- update and rollback-aware platform operation
- optional transitional integrations such as external caches and Flatpak where
  explicitly enabled

## Common Tasks

### Before A Release Cut

- verify the release channel and target audience
- confirm checksums, signatures, and artifact metadata are published
- confirm benchmark and accessibility evidence are attached where required
- rehearse rollback and update behavior for the planned channel mix

### Before A Linux Rollout

- validate the target image profile and hardware assumptions
- confirm system modules and package policies match the intended deployment
- verify update-agent and rollback paths on a non-production machine first
- decide whether optional transitional integrations should remain enabled

## Troubleshooting

| Situation                               | Use This Guide First    | Then Check                                |
| --------------------------------------- | ----------------------- | ----------------------------------------- |
| Release not reaching the right audience | `release/user-guide.md` | release runbook and rollout configuration |
| Artifacts rejected during install       | `release/user-guide.md` | checksum/signature verification           |
| Linux system not updating as expected   | `linux/user-guide.md`   | update-agent and channel configuration    |
| Linux recovery or rollback needed       | `linux/user-guide.md`   | recovery image and rollback procedures    |

## Related Documentation

- [Neith Domain Overview](./README.md)
- [Neith Release User Guide](./release/user-guide.md)
- [Neith Linux User Guide](./linux/user-guide.md)
- [Neith Domain Developer Guide](./developer-guide.md)
