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 an example of Trace instance for IO #1108

Merged
merged 4 commits into from
Dec 17, 2024

Conversation

mwz
Copy link
Contributor

@mwz mwz commented Dec 16, 2024

Hello, this PR adds a simple Trace[IO] example to the docs.
Would that be sufficient, or should I expand this to cover anything else?

@mergify mergify bot added the docs label Dec 16, 2024
@kubukoz
Copy link
Member

kubukoz commented Dec 16, 2024

I think the docs should use Trace.ioTraceForEntryPoint, it's more convenient.

It looks sufficient to me but I'd make that change^ :)

@mwz
Copy link
Contributor Author

mwz commented Dec 16, 2024

thanks @kubukoz, I've also added the EntryPoint example

@kubukoz
Copy link
Member

kubukoz commented Dec 16, 2024

sorry, I see I wasn't clear: I think the EntryPoint way should be the official recommendation, so it should go first. Is that OK with you?

@mwz
Copy link
Contributor Author

mwz commented Dec 17, 2024

Sounds good—I've updated it 👍🏻

@kubukoz kubukoz merged commit 699ca37 into typelevel:main Dec 17, 2024
13 checks passed
@mwz
Copy link
Contributor Author

mwz commented Dec 17, 2024

@kubukoz, how do we get the website deployed?
Do I need to manually pr the generated static content against the gh-pages branch? It looks like it hasn't been updated in 3 years 🙀

@kubukoz
Copy link
Member

kubukoz commented Dec 17, 2024

uh yeah I think we don't have any automation for the site. I'd rather we add a step that publishes to gh-pages as part of CI, using sbt-typelevel's github actions codegen; but regardless we should see if the build still works locally in the first place.

@mwz
Copy link
Contributor Author

mwz commented Dec 18, 2024

ok no worries - I'm happy to look into that

@mwz mwz deleted the add-trace-io-example branch December 18, 2024 15:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants