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 Phoenix examples readme to docs #404

Merged
merged 2 commits into from
Oct 30, 2024
Merged

Add Phoenix examples readme to docs #404

merged 2 commits into from
Oct 30, 2024

Conversation

jonatanklosko
Copy link
Member

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.

@@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

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

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?

Copy link
Member Author

Choose a reason for hiding this comment

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

You mean in the archive published to hex? How does this relate to rendering the docs?

Copy link
Contributor

@polvalente polvalente Oct 30, 2024

Choose a reason for hiding this comment

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

I meant that if the file is included, I believe it can be referenced as a relative path, but I might just be wrong

Copy link
Member Author

Choose a reason for hiding this comment

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

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"
Copy link
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Member Author

Choose a reason for hiding this comment

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

I think a redirect would be ideal, but I couldn't find such option.

@jonatanklosko jonatanklosko merged commit 9b1a937 into main Oct 30, 2024
2 checks passed
@jonatanklosko jonatanklosko deleted the jk-docs branch October 30, 2024 18:00
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