Add Phoenix examples readme to docs #404
Conversation
examples/phoenix/README.md
Outdated
| @@ -1,6 +1,6 @@ | |||
| # Phoenix LiveView examples | |||
|
|
|||
| This directory contains minimal, single-file LiveView applications, which showcase how to integrate Bumblebee as part of the application. | |||
| The [examples/phoenix](https://github.com/elixir-nx/bumblebee/tree/main/examples/phoenix) directory contains contains minimal, single-file LiveView applications, which showcase how to integrate Bumblebee as part of the application. | |||
There was a problem hiding this comment.
Since there's even a .md file there, can't we add the examples directory to the release and link to the actual .md file there?
There was a problem hiding this comment.
You mean in the archive published to hex? How does this relate to rendering the docs?
There was a problem hiding this comment.
I meant that if the file is included, I believe it can be referenced as a relative path, but I might just be wrong
There was a problem hiding this comment.
We could include them as assets, but then they are returned as raw files, not rendered by ex_doc, so the usability wouldn't be good.
| @@ -63,7 +63,8 @@ defmodule Bumblebee.MixProject do | |||
| "notebooks/stable_diffusion.livemd", | |||
| "notebooks/llms.livemd", | |||
| "notebooks/llms_rag.livemd", | |||
| "notebooks/fine_tuning.livemd" | |||
| "notebooks/fine_tuning.livemd", | |||
| "examples/phoenix/README.md" | |||
There was a problem hiding this comment.
I believe new ExDoc versions (or main) support redirects, so we could have a link that points directly to the GitHub repo. Either way is fine by me, your call.
There was a problem hiding this comment.
I think a redirect would be ideal, but I couldn't find such option.
Co-authored-by: José Valim <[email protected]>
The only issue I see is that the URLs point to main rather than docs-version branch. @josevalim let me know if you prefer a different approach.