Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: revamp README and usage guide #487

Open
syall opened this issue Dec 5, 2023 · 1 comment
Open

docs: revamp README and usage guide #487

syall opened this issue Dec 5, 2023 · 1 comment

Comments

@syall
Copy link
Contributor

syall commented Dec 5, 2023

Currently the smithy-go README is extremely minimal and has gaps in terms of DX.

This issue captures updating the README portion, e.g. #468
@michael-cico
Copy link

This is really needed, also in terms of user docs.

Are there any cookbook-style examples on how to set up the plugin for local usage of the plugin? I haven't found much. I was able to build this repo locally, but when I try the example under codegen/smithy-go-codegen-test I get

SUCCESS: Validated 209 shapes

Validated model, now starting projections...

Unable to find a plugin for `go-codegen` in the `source` projection. Is this the correct spelling? Are you missing a dependency? Is your classpath configured correctly?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@syall @michael-cico