aws / aws/aws-encryption-sdk-javascript

Create FAQ for common errors on encrypt/decrypt

Open
#305 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
260
Forks
68
Avg merge
22h 19m
Merged PRs (30d)
2

Description

Errors can bubble up from the encrypt/decrypt functions.
It would be nice to have clear explanations for common errors.

In creating this documentation,
the error messages can also be re-evaluated for clarity.

See #152 as an example.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing issue #152 and tracing the encrypt/decrypt functions to identify the common errors exposed to users. Document clear explanations for the selected errors, and record any error messages that need re-evaluation for clarity; done means the FAQ covers the agreed error cases and wording changes are decided.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation, security
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.