Skip to content

Adds user guides for v1.0.0 release#84

Merged
johnnyt merged 1 commit intomainfrom
73-user-guides
Feb 1, 2026
Merged

Adds user guides for v1.0.0 release#84
johnnyt merged 1 commit intomainfrom
73-user-guides

Conversation

@johnnyt
Copy link
Member

@johnnyt johnnyt commented Feb 1, 2026

  • Creates Getting Started guide with first encryption walkthrough
  • Creates Choosing Components guide with keyring/CMM decision trees
  • Creates Security Best Practices guide covering commitment policies
  • Adds automated testing infrastructure for guide code examples
  • Integrates guides into Hex documentation with cross-references
  • Links guides from main module and Client documentation

Closes #73

- Creates Getting Started guide with first encryption walkthrough
- Creates Choosing Components guide with keyring/CMM decision trees
- Creates Security Best Practices guide covering commitment policies
- Adds automated testing infrastructure for guide code examples
- Integrates guides into Hex documentation with cross-references
- Links guides from main module and Client documentation

Closes #73
@johnnyt johnnyt merged commit bb4662e into main Feb 1, 2026
1 check passed
@johnnyt johnnyt deleted the 73-user-guides branch February 1, 2026 16:00
@codecov
Copy link

codecov bot commented Feb 1, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

Impacted file tree graph

@@            Coverage Diff             @@
##             main      #84      +/-   ##
==========================================
+ Coverage   92.68%   92.75%   +0.06%     
==========================================
  Files          40       40              
  Lines        1435     1435              
==========================================
+ Hits         1330     1331       +1     
+ Misses        105      104       -1     
Files with missing lines Coverage Δ
lib/aws_encryption_sdk.ex 100.00% <ø> (ø)
lib/aws_encryption_sdk/client.ex 96.42% <ø> (ø)
lib/aws_encryption_sdk/keyring/behaviour.ex 100.00% <ø> (ø)

... and 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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.

Create User Guides for v1.0.0

1 participant