Tidy up documentation (#218)

coatless · web-flow · commit d09d15d16f31 · 2024-06-24T11:58:17.000-07:00
diff --git a/docs/_quarto.yml b/docs/_quarto.yml
@@ -69,7 +69,11 @@ website:
             text: Extension Website Notes
           - href: https://quarto-webr.thecoatlessprofessor.com/tests/
             text: Test Suite
-
+  body-footer: |
+    :::{.callout-important}
+    This Quarto extension is open source software and is **not affiliated with** Posit, Quarto, or webR. The extension is at best a community effort to simplify the integration of webR inside of Quarto generated documents.
+    :::
+  
 format:
   html:
     toc: true
diff --git a/docs/index.qmd b/docs/index.qmd
@@ -7,7 +7,7 @@ filters:
   - webr
 ---
 
-Welcome to the documentation portal for the [`quarto-webr`](https://github.com/coatless/quarto-webr) extension – your key to unlocking the endless possibilities of [webR](https://docs.r-wasm.org/webr/latest/) within various [Quarto](https://quarto.org/) formats, including [HTML](https://quarto.org/docs/output-formats/html-basics.html), [RevealJS](https://quarto.org/docs/presentations/revealjs/), [Websites](https://quarto.org/docs/websites/), [Blogs](https://quarto.org/docs/websites/website-blog.html), and [Books](https://quarto.org/docs/books). 
+Welcome to the documentation portal for the community [`quarto-webr`](https://github.com/coatless/quarto-webr) extension – your key to unlocking the endless possibilities of [webR](https://docs.r-wasm.org/webr/latest/) within various [Quarto](https://quarto.org/) formats, including [HTML](https://quarto.org/docs/output-formats/html-basics.html), [RevealJS](https://quarto.org/docs/presentations/revealjs/), [Websites](https://quarto.org/docs/websites/), [Blogs](https://quarto.org/docs/websites/website-blog.html), and [Books](https://quarto.org/docs/books). 
 
 Ready for an exciting journey into the world of webR's interactive code cells? Click the "Run Code" button below to experience it firsthand:
 
@@ -19,10 +19,6 @@ model = lm(mpg ~ wt, data = mtcars)
 summary(model)
 ```
 
-At its core, the [`quarto-webr` extension](https://github.com/coatless/quarto-webr) is designed to empower you to run R code directly in your web browser using familiar reporting tools, all without the need for an external R server.  Moreover, the extension abstracts away the need to know HTML or JavaScript to use webR. However, it's worth noting that you can also choose to unlock the full potential of webR and create more complex applications independently by directly using [webR's JavaScript API](https://docs.r-wasm.org/webr/latest/evaluating.html), granting you unparalleled freedom to harness the power of R in innovative ways.
+At its core, the community [`quarto-webr` extension](https://github.com/coatless/quarto-webr) is designed to empower you to run R code directly in your web browser using familiar reporting tools, all without the need for an external R server.  Moreover, the extension abstracts away the need to know HTML or JavaScript to use webR. However, it's worth noting that you can also choose to unlock the full potential of webR and create more complex applications independently by directly using **[webR's JavaScript API](https://docs.r-wasm.org/webr/latest/evaluating.html)**, granting you unparalleled freedom to harness the power of R in innovative ways.
 
 With this in mind, let's dive in and kickstart your journey with interactive code cells by [creating our very first webR-powered Quarto document](qwebr-first-steps.qmd) or [exploring some examples](qwebr-code-cell-demos.qmd)!
-
-:::{.callout-important}
-This Quarto extension is open source software and is **not affiliated with** Posit, Quarto, or webR. The extension is at best a community effort to simplify the integration of webR inside of Quarto generated documents.
-:::
diff --git a/docs/qwebr-acknowledgements.md b/docs/qwebr-acknowledgements.md
@@ -7,21 +7,21 @@ aliases:
   - webr-acknowledgements.html
 ---
 
-We would like to express our heartfelt gratitude to several individuals and teams who played a pivotal role in bringing [`quarto-webR`](https://github.com/coatless/quarto-webr) to life as an extension for Quarto. Without their dedication and contributions, this project would not have been possible.
+We would like to express our heartfelt gratitude to several individuals and teams who played a pivotal role in bringing [`quarto-webr`](https://github.com/coatless/quarto-webr) to life as an extension for Quarto. Without their dedication and contributions, this project would not have been possible.
 
 ## quarto-webr Extension Core Developers
 
 - [James Joseph Balamuta](https://github.com/coatless)
 - [JooYoung Seo](https://github.com/jooyoungseo) for accessibility improvements.
 
-Their relentless dedication have played a pivotal role in shaping the development of this extension.
+They played a pivotal role in shaping the development of this Quarto extension.
 
 ## webR Core Developers
 
 - [George Stagg](https://github.com/georgestagg)
 - [Lionel Henry](https://github.com/lionel-)
 
-Their tireless efforts and expertise in developing [webR](https://docs.r-wasm.org/webr/latest/) were instrumental in the development of this extension, and we are immensely grateful for their contributions.
+Their tireless efforts and expertise in developing [webR](https://docs.r-wasm.org/webr/latest/) were instrumental in being able to even develop this extension for Quarto. We are immensely grateful for their contribution of the webR project. Further, we greatly appreciate them answering our questions and providing guidance throughout the development process.
 
 ## Early Testing Feedback
 
@@ -40,7 +40,7 @@ We would like to acknowledge the Quarto team for their assistance in setting up
 
 Our project built upon the initial proof of concept for a standalone Quarto HTML document, made possible by the work of the [coatless-r-n-d/webR-quarto-demos](https://github.com/coatless-r-n-d/webR-quarto-demos) repository.
 
-Additionally, we were inspired by the following public-facing examples from the webR Core developers:
+Additionally, we were inspired by the following public-facing examples from the webR Core developers that contributed to the initial standalone experiment:
 
 - [Source of Tidyverse Blog Post](https://github.com/tidyverse/tidyverse.org/pull/617/files) and [Minor fix](https://github.com/tidyverse/tidyverse.org/commit/72bb2dd7ca0b2f211498a891aa54f55ddcad5014)
 - [webR documentation landing page](https://github.com/r-wasm/webr/blob/53acd8861c44f1f167941d0a40f62b0cc23852da/src/docs/index.qmd#L23-L68) ([Live page](https://docs.r-wasm.org/webr/latest/))
diff --git a/docs/qwebr-code-cell-demos.qmd b/docs/qwebr-code-cell-demos.qmd
@@ -14,7 +14,7 @@ aliases:
   - webr-code-cell-demos.html
 ---
 
-Welcome to the world of interactive code cells, unlocked by the `quarto-webr` extension. These cells allow you to run R code directly within your Quarto HTML documents, enabling real-time computations, dynamic visualizations, and more. Let's explore the impressive capabilities webR offers.
+Welcome to the world of interactive code cells, unlocked by the community `quarto-webr` extension. These cells allow you to run R code directly within your Quarto HTML documents, enabling real-time computations, dynamic visualizations, and more. Let's explore the impressive capabilities webR offers.
 
 # Creating webR-Enabled Code Cells
 
diff --git a/docs/qwebr-community-examples.qmd b/docs/qwebr-community-examples.qmd
@@ -10,11 +10,10 @@ aliases:
   - webr-community-examples.html
 ---
 
-Welcome to the Community Examples page for the `quarto-webr` extension. This section celebrates the diverse and innovative ways that members of our community are harnessing the power of the `quarto-webr` extension. These examples showcase real-world use cases, highlighting the extension's adaptability and functionality across various fields. You may also find references to examples from the [main webR project](https://webr.r-wasm.org/) here as well.
 
-Explore the projects, applications, educational materials, and more created by fellow users. Gain inspiration from the community's contributions and discover how you can leverage the full potential of `quarto-webr` in your own work. Whether your interests lie in data analysis, interactive reports, or educational resources, you'll find valuable insights and ideas within the community's projects.
+Welcome to the Community Examples page for the `quarto-webr` extension. Here, we showcase diverse and innovative ways that members of our community are using the extension. You'll find real-world examples of projects, applications, educational materials, and more created by fellow users.
 
-Do you have your own project or example that incorporates `quarto-webr`? We invite you to contribute to this growing collection of community-driven projects by submitting a [pull request](https://github.com/coatless/quarto-webr/edit/main/docs/qwebr-community-examples.qmd) or [creating an issue](https://github.com/coatless/quarto-webr/issues/new?assignees=&labels=community-example&projects=&template=community-example.yml&title=%5BExample%5D%3A+). Your experiences and creativity can inspire others and promote collaboration within our community. Together, we can continue to expand the possibilities of `quarto-webr`.
+Have a project using `quarto-webr`? Contribute by submitting a [pull request](https://github.com/coatless/quarto-webr/edit/main/docs/qwebr-community-examples.qmd) or [creating an issue](https://github.com/coatless/quarto-webr/issues/new?assignees=&labels=community-example&projects=&template=community-example.yml&title=%5BExample%5D%3A+). Your contributions can inspire and foster collaboration within our community, expanding the possibilities of `quarto-webr`.
 
 # Videos
 
@@ -27,6 +26,10 @@ Do you have your own project or example that incorporates `quarto-webr`? We invi
 
 **English**
 
+- [Andrew Heiss'](https://andrewheiss.com) conversion of [R Primers](https://r-primers.andrewheiss.com/). Spring 2024.
+  - [Source repository](https://github.com/andrewheiss/r-primers)
+- [Andrew Heiss'](https://andrewheiss.com)'s course [Data Visualization with R](https://datavizs24.classes.andrewheiss.com/lesson/06-lesson.html#histograms) at Georgia State University. Summer 2024.
+  - [Source repository](https://github.com/andrewheiss/r-primers)
 - [E.D. Gennatas](https://egenn.lambdamd.org/)'s tech demo with [progressive reveal tutorials](https://rtemis.org/pdsx/rdemo.html). Spring 2024.
 - Faculty of Medicine, University of Oslo's [MF9130E - Introductory Course in Statistics](https://www.uio.no/studier/emner/medisin/med/MF9130E/). Spring 2024.
   - [Sample Lab](https://ocbe-uio.github.io/teaching_mf9130e/lab/lab_distribution.html) and [source repo](https://github.com/ocbe-uio/teaching_mf9130e) announced on [Linkedin](https://www.linkedin.com/posts/andreaczhang_webr-rstats-quarto-activity-7183880219089334272-AZaq) 
@@ -54,6 +57,12 @@ Do you have your own project or example that incorporates `quarto-webr`? We invi
 - [Javier Arántegui](https://github.com/runjaj)'s course [Calidad 2023-24](https://runjaj.quarto.pub/calidad-23-24-gcta) contained short R Tutorials with examples using `quarto-webr`
   - [Lecture: Introduction to R (Spanish)](https://runjaj.quarto.pub/calidad-23-24-gcta/intro_R.html), [Lecture: Acceptance Sampling](https://runjaj.quarto.pub/calidad-23-24-gcta/intro_AcceptanceSampling.html), and [mastodon tweet](https://mastodon.social/@runjaj/112241537253261459).
 
+
+**Turkish**
+
+- [Alper Yilmaz](https://github.com/alperyilmaz)'s lecture notes for [MBG1032 Biyoistatistik](https://alperyilmaz.github.io/biostats-webr). Spring 2024.
+  - [Source](https://github.com/alperyilmaz/biostats-webr)
+
 # Talks
 
 - [Nicola Rennie](https://nrennie.rbind.io/)'s talk on [Teaching statistics interactively with webR](https://nrennie.rbind.io/talks/rss-conference-teaching-webr/). Nov 22th, 2023 @ RSS/RoSE UK Statistics Education Meeting 2023
@@ -76,10 +85,6 @@ Do you have your own project or example that incorporates `quarto-webr`? We invi
   - [Slides](https://mine-cetinkaya-rundel.github.io/teach-with-quarto/talks/5-teaching-materials/) and [Source code](https://github.com/mine-cetinkaya-rundel/teach-with-quarto/tree/main/talks/5-teaching-materials)
   - [WebR Demo](https://maria.quarto.pub/webr-demo/) on [Quarto Pub](https://quarto.pub)
 
-**Turkish**
-
-- [Alper Yilmaz](https://github.com/alperyilmaz)'s lecture notes for [MBG1032 Biyoistatistik](https://alperyilmaz.github.io/biostats-webr). Spring 2024.
-  - [Source](https://github.com/alperyilmaz/biostats-webr)
 
 # Textbooks
 
@@ -142,6 +147,8 @@ Do you have your own project or example that incorporates `quarto-webr`? We invi
 
 **English**
 
+- [Pawel Rucki](https://pawelru.github.io/cv/)'s post on the Pharmaverse blog [TLG Catalog 🤝 WebR](https://pharmaverse.github.io/blog/posts/2024-05-08_tlg_catalog_webr/tlg_catalog_webr.html).
+  - [Example page: ADAT01](https://insightsengineering.github.io/tlg-catalog/stable/tables/ADA/adat01.html#tabset-1-2) and [Source repository](https://github.com/insightsengineering/tlg-catalog).
 - Rodolfo Lourenzutti's tutorial post on [A/B Testing](https://lourenzutti.github.io/tutorials/AB-testing/ab-test.html). Apr 3rd, 2024.
   - [Source](https://github.com/Lourenzutti/lourenzutti.github.io/blob/master/tutorials/AB-testing/ab-test.qmd)
 - [Claudiu Papasteri](https://github.com/ClaudiuPapasteri)'s post on [Hugo blogdown posts with in-browser interactive code chunks using webR and Quarto?](https://claudiu.psychlab.eu/post/hugo-blogdown-interactive-code-chunk-webr-quarto/). Feb 5th, 2024.
diff --git a/docs/qwebr-deployment-templates.qmd b/docs/qwebr-deployment-templates.qmd
@@ -4,7 +4,7 @@ date: "10-01-2023"
 date-modified: last-modified
 ---
 
-Discover a range of sample deployment templates for the `quarto-webr` extension at our GitHub repository [here](https://github.com/coatless/quarto-webr/tree/main/examples). These templates serve as convenient starting points for various web-based projects that harness the power of the `quarto-webr` extension, enabling interactive data analysis inside of a web browser. Whether you're embarking on an individual report, creating an interactive website, or compiling a digital book, these templates simplify the process, making it effortless to kickstart your own projects.
+Discover a range of sample deployment templates for the community `quarto-webr` extension at our [GitHub repository](https://github.com/coatless/quarto-webr/tree/main/examples). These templates serve as convenient starting points for various web-based projects that harness the power of the `quarto-webr` extension, enabling interactive data analysis inside of a web browser. Whether you're embarking on an individual report, creating an interactive website, or compiling a digital book, these templates simplify the process, making it effortless to kickstart your own projects.
 
 # HTML Document Template
 
diff --git a/docs/qwebr-developer-resources.qmd b/docs/qwebr-developer-resources.qmd
@@ -8,19 +8,19 @@ format:
     toc: true
 ---
 
-Are you eager to contribute to the development of the `quarto-webr` extension or explore ways to modify it to suit your needs? This resource page is your guide to invaluable tools and references that will empower you on your development journey.
+Want to contribute to the `quarto-webr` extension or customize it? This resource page guides you with essential tools and references.
 
 ## Mastering webR
 
-Before diving into extension development, it's essential to understand the core of what powers the `quarto-webr` extension: [webR](https://docs.r-wasm.org/webr/latest/). These webR resources will be your trusty companions:
+Understanding [webR](https://docs.r-wasm.org/webr/latest/), which powers the interactivity, is crucial for developing `quarto-webr`. Review these resources:
 
-- **[webR Documentation](https://docs.r-wasm.org/webr/latest/)**: This comprehensive documentation is your gateway to a deep understanding of webR. It provides profound insights into webR's features, usage, and capabilities. Dive into practical examples, comprehensive guides, and everything you need to become a webR expert.
+- **[webR Documentation](https://docs.r-wasm.org/webr/latest/)**: Comprehensive guides and examples to deepen your webR knowledge.
+- **[webR Source Code](https://github.com/r-wasm/webr/)**: For the technically curious, explore the official webR project's development on GitHub.
+- **[Bob Rudis' Experiments with webR](https://rud.is/webr-experiments/)**: Discover diverse projects using the webR JavaScript API.
 
-- **[webR Source Code](https://github.com/r-wasm/webr/)**: For the technically curious, webR's GitHub source code repository offers transparency into the development of webR. Here, you can review, contribute, and engage with the vibrant webR community to enhance its capabilities.
+These resources will help you master webR and, subsequently, your ability to create interactive code cells in HTML documents. Remember, webR is a versatile tool that can be used independently or alongside the community Quarto extension to unlock the magic of interactive code cells in HTML documents.
 
-- **[Bob Rudis' Experiments with webR](https://rud.is/webr-experiments/)**: Many different projects that explore a variety of use cases for webR. These experiments make use of the underlying webR JavaScript API.
-
-These resources empower you to master webR, whether you're just starting out or you're a seasoned developer eager to contribute. Remember, webR is a versatile tool that can be used independently or alongside the Quarto extension to unlock the magic of interactive code cells in HTML documents.
+Want to contribute to the `quarto-webr` extension or customize it? This resource page guides you with essential tools and references.
 
 ## Quarto Development Ecosystem
 
diff --git a/docs/qwebr-faq.qmd b/docs/qwebr-faq.qmd
@@ -1,6 +1,6 @@
 ---
 title: "Frequently Asked Questions"
-subtitle: "Find Answers to Common Queries About `quarto-webr` Extension"
+subtitle: "Find Answers to Common Queries About the community `quarto-webr` Extension"
 date: "10-01-2023"
 date-modified: last-modified
 engine: markdown
@@ -11,7 +11,7 @@ aliases:
   - webr-faq.html
 ---
 
-Welcome to our Frequently Asked Questions (FAQ) page, your go-to resource for finding answers to common queries about the `quarto-webr` extension.  If you can't find the answer you're looking for, don't hesitate to reach out to our community for additional support by opening a [question](https://github.com/coatless/quarto-webr/issues/new?assignees=&labels=q%26a&projects=&template=question.yml&title=%5BQ%26A%5D%3A+) or a [bug report](https://github.com/coatless/quarto-webr/issues/new?assignees=&labels=bug%2Ctriage-needed&projects=&template=bug-report.yml&title=%5BBug%5D%3A+) on the [issue tracker](https://github.com/coatless/quarto-webr/issues).
+Welcome to our Frequently Asked Questions (FAQ) page, your go-to resource for finding answers to common queries about the community `quarto-webr` extension.  If you can't find the answer you're looking for, don't hesitate to reach out to our community for additional support by opening a [question](https://github.com/coatless/quarto-webr/issues/new?assignees=&labels=q%26a&projects=&template=question.yml&title=%5BQ%26A%5D%3A+) or a [bug report](https://github.com/coatless/quarto-webr/issues/new?assignees=&labels=bug%2Ctriage-needed&projects=&template=bug-report.yml&title=%5BBug%5D%3A+) on the [issue tracker](https://github.com/coatless/quarto-webr/issues).
 
 # Stability and Long Term Support
 
diff --git a/docs/qwebr-first-steps.qmd b/docs/qwebr-first-steps.qmd
@@ -73,7 +73,7 @@ If an engine is not specified, Quarto will attempt to use the `jupyter` compute
 
 # Fin
 
-In summary, this guide has provided an overview of how to incorporate the `quarto-webr` extension into your Quarto HTML documents using RStudio. We began with a walkthrough video that offered an in-depth understanding of how this Quarto extension operates within the Quarto framework. Subsequently, we explored key workflow changes necessary for incorporating webR into your Quarto HTML documents, from installation to document rendering.
+In summary, this guide has provided an overview of how to incorporate the community `quarto-webr` extension into your Quarto HTML documents using RStudio. We began with a walkthrough video that offered an in-depth understanding of how this Quarto extension operates within the Quarto framework. Subsequently, we explored key workflow changes necessary for incorporating webR into your Quarto HTML documents, from installation to document rendering.
 
 For your next steps consider looking at different use cases for [interactive options](qwebr-code-cell-demos.qmd).
 
diff --git a/docs/qwebr-internal-cell.qmd b/docs/qwebr-internal-cell.qmd
diff --git a/docs/qwebr-loading-data.qmd b/docs/qwebr-loading-data.qmd
diff --git a/docs/qwebr-troubleshooting.qmd b/docs/qwebr-troubleshooting.qmd
diff --git a/docs/qwebr-using-r-packages.qmd b/docs/qwebr-using-r-packages.qmd
