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

More breadcrumbs between examples and templates #1682

Open
nealrichardson opened this issue Sep 12, 2024 · 1 comment
Open

More breadcrumbs between examples and templates #1682

nealrichardson opened this issue Sep 12, 2024 · 1 comment

Comments

@nealrichardson
Copy link
Collaborator

I was looking for the example OpenAI chat app and couldn't find it. https://github.com/posit-dev/py-shiny/blob/main/examples/chat/playground/app.py#L6 even says it should be there. Looking at git history, I discovered that it was moved to the templates inside the package.

As a user, it's not obvious what the difference between examples and templates are. (Is there one?) It would be nice to have more "see also" comments in the examples and templates--maybe that's only an issue for the chat ones because the other examples are self-contained and don't need to reference each other. At a minimum it would be good to update the code comments to point to the right place.

Related: #1671

@gadenbuie
Copy link
Collaborator

For context, examples live only in the repo and aren't bundled in the package; the templates on the other hand are part of the shiny package and are available via shiny create, which now includes a "Generative AI templates..." menu item (happened in #1631).

With the latest version of shiny, you can now run the following to get started with the OpenAI chat app

shiny create --template chat-ai-openai

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

No branches or pull requests

2 participants