aws / aws/aws-sdk-js-codemod

[Feature]: Create a documentation website for supported test cases

Open
#117 0 comments 2 reactions 0 assignees View on GitHub
enhancement p3
Dominant language
TypeScript
Stars
89
Forks
13
Avg merge
9h 59m
Merged PRs (30d)
1

Description

### Is your feature request related to a problem? Please describe.
The supported test cases are not documented anywhere. They can be viewed in [`__fixtures__`][__fixtures__] directory.

### Describe the solution you'd like
Create a documentation website with supported test cases.

### Describe alternatives you've considered
Going through [`__fixtures__`][__fixtures__] directory for supported test cases

### Additional context
Alternatively, a playground link will be helpful requested in https://github.com/awslabs/aws-sdk-js-codemod/issues/116

[__fixtures__]: https://github.com/awslabs/aws-sdk-js-codemod/tree/main/src/transforms/v2-to-v3/__fixtures__

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the supported test cases in the linked src/transforms/v2-to-v3/__fixtures__ directory and compare the request with issue #116's playground alternative. Define the documentation website's scope and verify that it covers the supported cases in a browsable form; the issue does not name an implementation entry point or test.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.