aws-samples / aws-samples/aws-dynamodb-examples
[Workshop] - Modernizer - Align README with workshop description
- Dominant language
- TypeScript
- Stars
- 602
- Forks
- 242
- Avg merge
- 14m
- Merged PRs (30d)
- 2
Description
The workshop readme has conflicting language with the instructions in workshop studio, which causes confusions to some of the participants. The objective of the README file is to allow developers to understand what was developed and the current file looks more like a mix of instructions and development instructions.
The proposal is to split the file into normal README.md that includes development instructions and the backend and another file that can provide instructions to users that will run this workshop on their own and not using workshop studio environment.
Contributor guide
Research direction
Start with the workshop README and compare its language with the instructions in the workshop Studio environment. Separate development and backend information into README.md and create a second document for users running the workshop independently; done means the two audiences have clear, non-conflicting instructions.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100