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.

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

add quickstart guide to docs #62

Merged
merged 9 commits into from
Jan 21, 2022
Merged

add quickstart guide to docs #62

merged 9 commits into from
Jan 21, 2022

Conversation

lewisjkl
Copy link
Contributor

What I added is based off a simple project I created here: https://github.com/lewisjkl/smithy4s-minimal-example

Happy to move that project into this repo as an example if we want to.

Comment on lines +30 to +31
"com.disneystreaming.smithy4s" %% "smithy4s-http4s" % smithy4sVersion.value,
"com.disneystreaming.smithy4s" %% "smithy4s-http4s-swagger" % smithy4sVersion.value,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So technically, smithy4s-http4s-swagger brings in smithy4s-http4s transitively, should we still include both here? My gut says we should leave both.. but wanted to get other thoughts

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personally I don't care much about explicit dependencies, transitive is fine for me - I'd leave just the one that takes in all the others

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the sake of this doc, I'd rather keep both.

@kubukoz
Copy link
Member

kubukoz commented Jan 21, 2022

LGTM, what do you think about also showing a client? Maybe a simple main class (IOApp) that hits a single endpoint?

@lewisjkl
Copy link
Contributor Author

LGTM, what do you think about also showing a client? Maybe a simple main class (IOApp) that hits a single endpoint?

Yeah that's a good idea, I think it'd be nice to call out that it can do clients right up front like that.

@lewisjkl lewisjkl merged commit 58f87b3 into main Jan 21, 2022
@lewisjkl lewisjkl deleted the quickstart branch January 21, 2022 17:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants