From 012e23275d06deb7cb4a0650c0909cce9f7d4327 Mon Sep 17 00:00:00 2001 From: kbvernon Date: Tue, 2 Apr 2024 19:29:56 -0600 Subject: [PATCH 1/2] add some motivation for the user guide --- index.qmd | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/index.qmd b/index.qmd index 22ca43b..681a896 100644 --- a/index.qmd +++ b/index.qmd @@ -4,4 +4,19 @@ title: "extendR: User guide" # Introduction -extendR is a suite of software packages concerned with bridging R and Rust, through automatically generated bindings. See for more information. This website is a _user_ guide to all things extendr, Rust, R and the confluence of all three. +The extendr suite of software packages provides a set of utilities for bridging +the R and Rust programming languages, making it easier for users to pass data +between them using automatically generated bindings. In so doing, it overcomes a +fundamental challenge of all such language bindings, namely, the fact that the +two languages make different design choices regarding the representation of data +types. Most of the time, data types in Rust and R map quite nicely. In other +cases, it takes careful consideration. And, in a few unfortunate cases, it is +not even possible. Generally speaking, though, if an R version of a Rust type +exists, extendr will do that mapping for you, but you will on occasion have to +do some of that work yourself. + +To help guide you toward best practices here, we have put together this website +as a *user* guide, with lots of examples showcasing all things extendr, Rust, +and R, as well as the confluence of all three. + +See for more information. \ No newline at end of file From e6e51932fe899d46ebe1a64e6b12be05ef85cd36 Mon Sep 17 00:00:00 2001 From: kbvernon Date: Tue, 2 Apr 2024 19:48:19 -0600 Subject: [PATCH 2/2] move discord link to intro --- getting-started.qmd | 4 ---- index.qmd | 8 +++++++- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/getting-started.qmd b/getting-started.qmd index a5b5664..8514c8e 100644 --- a/getting-started.qmd +++ b/getting-started.qmd @@ -4,10 +4,6 @@ title: Getting started To start building R packages using extendr you will need to have R and Rust toolchain installed on your machine. -::: callout-tip -Join the [Discord server](https://discord.gg/KM3Bhwt3uk) server to chat with other extendr users and the maintainers. -::: - ## R Ensure that you have a relatively new version of R installed. It is recommended to use a moderately new version (>= 4.2.0). diff --git a/index.qmd b/index.qmd index 681a896..165378c 100644 --- a/index.qmd +++ b/index.qmd @@ -19,4 +19,10 @@ To help guide you toward best practices here, we have put together this website as a *user* guide, with lots of examples showcasing all things extendr, Rust, and R, as well as the confluence of all three. -See for more information. \ No newline at end of file +See for more information. + +## Community Support + +If you have any questions or are looking for advice, feel free to join the +community's [Discord server](https://discord.gg/KM3Bhwt3uk). You can usually +find the maintainers there, as well as other helpful extendr users.