genfile 0.6.0

CLI for genfile_core template archive management - create, manage, and materialize code generation templates.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

# Invariant: Documentation

### Scope

- **Purpose**: Ensures the CLI is well-documented for users and contributors.
- **Responsibility**: Documents the documentation completeness requirements.
- **In Scope**: README quick start, all public items documented, working examples, `cargo doc` clean build.
- **Out of Scope**: Architectural design docs (→ `docs/`), test documentation.

### Invariant Statement

The `readme.md` must include a quick start guide and at least one end-to-end workflow example. All public items must have doc comments. All documentation examples must compile and run. Doc-test validation must produce zero warnings.

### Enforcement Mechanism

A compile-time lint enforces doc comment coverage on all public items. Doc-test validation ensures all documentation examples compile and run. README is manually reviewed for completeness during release.

### Violation Consequences

Missing documentation is the primary barrier to adoption. Users cannot discover commands or understand parameters without a working quick start. Broken examples erode confidence in the library.

### Features

| File | Relationship |
|------|--------------|
| [`feature/009_help_system.md`](../feature/009_help_system.md) | Help system that must provide complete command documentation |

### Docs

| File | Relationship |
|------|--------------|
| [`docs/cli/readme.md`](../cli/readme.md) | CLI design documentation for contributors |

### Sources

| File | Relationship |
|------|--------------|
| [`src/lib.rs`](../../src/lib.rs) | Compile-time missing-docs lint enforcement |