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

Overhaul "Learn Shiny" content to be Express focused #68

Merged
merged 16 commits into from
Jan 24, 2024

Conversation

cpsievert
Copy link
Contributor

@cpsievert cpsievert commented Jan 15, 2024

To preview locally (with the shinylive extension using the latest versions of packages):

# First, make sure you can build shinylive
git clone https://github.com/posit-dev/shinylive
cd shinylive
make submodules
make all

# Link shinylive CLI to freshly built assets
pip install shinylive
shinylive assets link-from-local ./build

# Re-build with latest dev versions
cd packages
cd py-htmltools && git pull && cd ..
cd py-shiny && git pull && cd ..
cd py-shinywidgets && git pull && cd ..
cd py-faicons && git pull && cd ..
cd ..
make clean && make all

# Finally, build py-shiny-site from this branch
git clone https://github.com/posit-dev/py-shiny-site
cd py-shiny-site
git checkout learn-shiny-overhaul
make serve

_quarto.yml Show resolved Hide resolved
_quarto.yml Show resolved Hide resolved
@cpsievert cpsievert force-pushed the learn-shiny-overhaul branch from 05458d9 to 749e7d2 Compare January 15, 2024 21:08
docs/jupyter-widgets.qmd Outdated Show resolved Hide resolved
@cpsievert cpsievert force-pushed the learn-shiny-overhaul branch from 749e7d2 to 14b1a93 Compare January 16, 2024 17:16
@jcheng5 jcheng5 mentioned this pull request Jan 16, 2024
55 tasks
@cpsievert cpsievert force-pushed the learn-shiny-overhaul branch from 14b1a93 to dd3cc6e Compare January 16, 2024 19:53
@cpsievert cpsievert marked this pull request as ready for review January 16, 2024 19:53
@cpsievert cpsievert requested a review from jcheng5 January 16, 2024 20:04
docs/create-run.qmd Outdated Show resolved Hide resolved
docs/create-run.qmd Outdated Show resolved Hide resolved
docs/create-run.qmd Outdated Show resolved Hide resolved
docs/create-run.qmd Outdated Show resolved Hide resolved
docs/create-run.qmd Outdated Show resolved Hide resolved
docs/dashboards.qmd Outdated Show resolved Hide resolved
docs/dashboards.qmd Show resolved Hide resolved
docs/debug.qmd Outdated Show resolved Hide resolved
docs/install-create-run.qmd Outdated Show resolved Hide resolved
docs/install-create-run.qmd Show resolved Hide resolved
@cpsievert cpsievert force-pushed the learn-shiny-overhaul branch from b140c4b to 3b2aaca Compare January 19, 2024 00:46
Copy link
Contributor

@gshotwell gshotwell left a comment

Choose a reason for hiding this comment

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

Got up to the ui sections. I think this is great, but the reactive programming stuff still seems like it's not quite right for people learning about reactivity for the first time. I think we should ship them because they're still a big improvement, but we may want to revisit them again fairly soon.

docs/jupyter-widgets.qmd Outdated Show resolved Hide resolved
docs/jupyter-widgets.qmd Outdated Show resolved Hide resolved
docs/jupyter-widgets.qmd Outdated Show resolved Hide resolved
docs/jupyter-widgets.qmd Outdated Show resolved Hide resolved
docs/jupyter-widgets.qmd Outdated Show resolved Hide resolved
docs/reactive-patterns.qmd Show resolved Hide resolved
docs/reactive-patterns.qmd Show resolved Hide resolved
docs/reactive-patterns.qmd Show resolved Hide resolved
docs/reactive-patterns.qmd Show resolved Hide resolved
docs/reactive-patterns.qmd Show resolved Hide resolved
Copy link
Contributor

@gshotwell gshotwell left a comment

Choose a reason for hiding this comment

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

Looks great, one thing is that quite a lot of sentences start with some version of "it's often useful" or "it's sometimes useful". I think we can more or less get rid of all of these and just jump right into the content. I made some suggested changes, but flagged a few of them just to be revised. I think it's a good idea to use second person language in these cases "input.select is for when you want to select an input"

docs/ui-customize.qmd Show resolved Hide resolved
docs/ui-dynamic.qmd Outdated Show resolved Hide resolved
docs/ui-dynamic.qmd Outdated Show resolved Hide resolved
docs/ui-dynamic.qmd Outdated Show resolved Hide resolved
docs/ui-dynamic.qmd Outdated Show resolved Hide resolved
docs/ui-html.qmd Outdated Show resolved Hide resolved
docs/ui-html.qmd Outdated Show resolved Hide resolved
docs/ui-html.qmd Outdated Show resolved Hide resolved
docs/ui-layouts.qmd Outdated Show resolved Hide resolved

### `page_navbar()`

A multi-page application, with an optional sidebar.
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we want to say more about this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ahh sorry, this was another file that should've been removed (we can lean on the layout gallery instead now).

Copy link
Contributor

@gshotwell gshotwell left a comment

Choose a reason for hiding this comment

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

I'm sorry to say I really don't like the direction that the Motivate express article has gone in. My main concern with Express is that we want to avoid abandoning Shiny Core, and so we need a very clear article which articulates why people should still care about and use Shiny Core. Currently the Express-Core translation article reads more like "Here's why you might think you need Shiny Core but really Express does all of those things too", and includes much more express code than Core code. My suggestion is:

  • Write a new article called "programming with express" that covers @expressify @hold @render.express and talks about managing complexity in Express.
  • Reference that article in a callout, but have this article be all about the virtues of Core.

If we don't have a clear articulation of why Core is good, Express looks a lot more like something that supersedes Core entirely than adjuvant syntax.

docs/express-motivation.qmd Outdated Show resolved Hide resolved
docs/express-motivation.qmd Outdated Show resolved Hide resolved
docs/express-motivation.qmd Outdated Show resolved Hide resolved
docs/express-motivation.qmd Outdated Show resolved Hide resolved
docs/express-motivation.qmd Outdated Show resolved Hide resolved
docs/express-motivation.qmd Outdated Show resolved Hide resolved
docs/express-motivation.qmd Outdated Show resolved Hide resolved
docs/express-motivation.qmd Outdated Show resolved Hide resolved
docs/express-motivation.qmd Outdated Show resolved Hide resolved
docs/express-motivation.qmd Outdated Show resolved Hide resolved
@cpsievert cpsievert merged commit 8d0eac9 into rc-express Jan 24, 2024
@cpsievert cpsievert deleted the learn-shiny-overhaul branch January 24, 2024 16:31
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.

2 participants