docs: revamp README and usage guide
Open
- Dominant language
- Java
- Stars
- 255
- Forks
- 81
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 7
Description
Currently the smithy-go README is extremely minimal and has gaps in terms of DX.
This issue captures updating the README portion, e.g. https://github.com/aws/smithy-go/pull/468
Contributor guide
Research direction
Review the current README and usage guide, then compare the requested changes with pull request 468. Identify the missing developer-experience information and update the named documentation; done means the README and usage guide address the documented gaps.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100