docs(pkgdown): Re-organize and add descriptions to reference index #842

gadenbuie · 2023-10-17T21:12:14Z

Closes #808

Re-organizes reference page using level-2 and level-3 headings, i.e. one level of abstraction above what we had before. We now have four top-level headings: Page Layouts, User Interface Layouts, Components, Theming, and Utility Functions.
Gives orienting descriptions to each of the sub-sections (level-3 groups).
page_navbar() and page_fillable() now have their own reference pages, separate from page().
We now consistently use @examplesIf rlang::is_interactive().
I updated the reference index styles with some small tweaks that improve the readability and help to separate the four topics.

Preview (screenshot)

Also prefer `rlang::is_interactive()`

_pkgdown.yml

Co-authored-by: Carson Sievert <[email protected]>

_pkgdown.yml

cpsievert · 2023-10-17T22:10:21Z

R/page.R

+#' library(shiny)
+#' library(ggplot2)
+#'
+#' ui <- page_fillable(
+#'   h1("Example", code("mtcars"), "dashboard"),
+#'   layout_columns(
+#'     card(
+#'       full_screen = TRUE,
+#'       card_header("Number of forward gears"),
+#'       plotOutput("gear")
+#'     ),
+#'     card(
+#'       full_screen = TRUE,
+#'       card_header("Number of carburetors"),
+#'       plotOutput("carb")
+#'     )
+#'   ),
+#'   card(
+#'     full_screen = TRUE,
+#'     card_header("Weight vs. Quarter Mile Time"),
+#'     layout_sidebar(
+#'       sidebar = sidebar(
+#'         varSelectInput("var_x", "Compare to qsec:", mtcars[-7], "wt"),
+#'         varSelectInput("color", "Color by:", mtcars[-7], "cyl"),
+#'         position = "right"
+#'       ),
+#'       plotOutput("var_vs_qsec")
+#'     )
+#'   )
+#' )
+#'
+#' server <- function(input, output) {
+#'   for (var in c("cyl", "vs", "am", "gear", "carb")) {
+#'     mtcars[[var]] <- as.factor(mtcars[[var]])
+#'   }
+#'
+#'   output$gear <- renderPlot({
+#'     ggplot(mtcars, aes(gear)) + geom_bar()
+#'   })
+#'
+#'   output$carb <- renderPlot({
+#'     ggplot(mtcars, aes(carb)) + geom_bar()
+#'   })
+#'
+#'   output$var_vs_qsec <- renderPlot({
+#'     req(input$var_x, input$color)
+#'
+#'     ggplot(mtcars) +
+#'       aes(y = qsec, x = !!input$var_x, color = !!input$color) +
+#'       geom_point()
+#'   })
+#' }
+#'
+#' shinyApp(ui, server)


Nice! Maybe once shiny::runExample() gets an extension point this would be a good candidate for an example?

Thanks and yeah, good idea!

R/page.R

…umn layout functions

_pkgdown.yml

R/page.R

cpsievert

Nicely done, thanks! Feel free to merge once the last few comments are addressed

R/page.R

Co-authored-by: Carson Sievert <[email protected]>

gadenbuie added 5 commits October 17, 2023 16:15

docs(pkgdown): Soften template reference description

ffdd788

docs(pkgdown): Reorganize reference index

f933c1f

docs: Separate page_navbar() and page_fillable()

36726c6

Also prefer `rlang::is_interactive()`

docs(pkgdown): Add page_fillable() to dashboard layouts section

05e4d86

docs(pkgdown): Copy-edit popovers description

b88cd92

gadenbuie requested a review from cpsievert October 17, 2023 21:12