Skip to content

Organizes Hex docs#83

Merged
johnnyt merged 1 commit intomainfrom
72-hex-docs-organization
Feb 1, 2026
Merged

Organizes Hex docs#83
johnnyt merged 1 commit intomainfrom
72-hex-docs-organization

Conversation

@johnnyt
Copy link
Member

@johnnyt johnnyt commented Feb 1, 2026

  • Groups all modules into 12 logical categories in documentation
  • Adds comprehensive @moduledoc to streaming components explaining when to use streaming, memory benefits, and integration patterns
  • Creates API Stability Policy guide documenting semantic versioning commitment, breaking change policy, and deprecation process
  • Enhances Stream.Decryptor docs with plaintext verification status guidance for signed algorithm suites

Closes #72

- Groups all modules into 12 logical categories in documentation
- Adds comprehensive @moduledoc to streaming components explaining
  when to use streaming, memory benefits, and integration patterns
- Creates API Stability Policy guide documenting semantic versioning
  commitment, breaking change policy, and deprecation process
- Enhances Stream.Decryptor docs with plaintext verification status
  guidance for signed algorithm suites

Closes #72
@johnnyt johnnyt merged commit 1bd3a01 into main Feb 1, 2026
4 checks passed
@johnnyt johnnyt deleted the 72-hex-docs-organization branch February 1, 2026 15:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Complete Hex Docs Organization for v1.0.0

1 participant