User#

Welcome. This guide is a practical adoption path for developers integrating ArgDigest into their own libraries.

If you follow the pages in order, you will move from a first working setup to production-ready integration patterns.

The main audience is library integrators, but this section also includes one page for end users who consume libraries that already integrate ArgDigest.

Before implementation, keep the contract guide at hand:

ARG_DIGEST_AGENTS.md

Fast Track (20 minutes)#

If you want the minimum path first, read in this order:

Learning Path#

What ArgDigest Solves: scope, value, and non-goals.
Quick Start: first working integration in minutes.
Integration Cheat Sheet: copy-ready minimal setup.
Mini Library Walkthrough: complete narrative from zero to production shape.
Configuration: how _argdigest.py defines defaults and policy.
Configuration Precedence: exact resolution order and override rules.
Digestion Styles: package, registry, decorator, and mixed approaches.
Auto Mode and Conflict Resolution: how auto chooses digesters and how to avoid ambiguity.
Normalization: argument name standardization before digestion.
skip_digestion Behavior: bypass semantics and safe usage.
Pipeline Design Patterns: robust rule design and context usage.
Strictness and Errors: warning/error behavior and troubleshooting signals.
SMonitor Integration: what structured diagnostics look like in practice.
Migration: warn to error: staged hardening criteria.
Integrating Your Library: migration blueprint for real codebases.
Examples: where to find copy-ready integration scenarios.
Troubleshooting: quick diagnosis for common failures.
Production Checklist: final pre-release verification.
For End Users of Integrating Libraries: how to interpret validation messages in real usage.
FAQ: short answers to recurring adoption questions.