waddling-errors 0.7.3

Structured, secure-by-default diagnostic codes for distributed systems with no_std and role-based documentation
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

# Documentation

Welcome to the waddling-errors documentation!

## For Users

- **[../README.md](../README.md)** - Main documentation, installation, usage examples
- **[../CHANGELOG.md](../CHANGELOG.md)** - Version history and release notes
- **[FEATURE_FLAGS.md](FEATURE_FLAGS.md)** - Optional features and configuration
- **[SEQUENCE-CONVENTIONS.md](SEQUENCE-CONVENTIONS.md)** - Semantic sequence number conventions

## For Contributors

- **Architecture documentation** - See individual source files for module documentation
- **Examples** - See `../examples/` directory for working examples:
  - `trait_based_enums.rs` - Core trait-based API
  - `trait_based_documented.rs` - Documentation traits
  - `wasm_minimal.rs` - no_std proof

## For Maintainers

- **[maintenance/RELEASE.md](maintenance/RELEASE.md)** - Complete release process and checklist
- **[maintenance/PUBLISHING.md](maintenance/PUBLISHING.md)** - One-time setup for crates.io publishing

---

**Project Structure:**
```
waddling-errors/
├── README.md                      # Main documentation (start here!)
├── CHANGELOG.md                   # Version history
├── Cargo.toml                     # Package configuration
├── docs/
│   ├── README.md                  # This file
│   ├── FEATURE_FLAGS.md           # Optional features
│   ├── SEQUENCE-CONVENTIONS.md    # Error code conventions
│   └── maintenance/
│       ├── RELEASE.md             # Release process
│       └── PUBLISHING.md          # Publishing setup
├── src/
│   ├── lib.rs                     # Public API
│   ├── severity.rs                # Severity enum
│   ├── code.rs                    # Code struct with generic types
│   ├── traits.rs                  # ComponentId/PrimaryId traits
│   └── hash.rs                    # Optional hash feature
└── examples/
    ├── trait_based_enums.rs       # Core API demo
    ├── trait_based_documented.rs  # Documentation traits
    └── wasm_minimal.rs            # no_std proof
```

---

## Documentation Philosophy

**v0.6.0 focuses on clarity and directness:**

- ✅ **User-facing docs** - What users need to use the library
- ✅ **Convention docs** - Shared patterns across ecosystem
- ✅ **Maintainer docs** - How to release and publish
- ❌ **Implementation details** - Moved to source code comments
- ❌ **Theoretical strategies** - Removed until implemented