Overhaul

[kbvernon]

Addresses #76

Changes:

1. Added consistent styling and official palette in extendr.scss
2. Added contributor guide (or the start of one)
3. Consolidated text and content in intro-rust and added more output for examples (showing result of cargo run --quiet)
4. Moved most of the user-guide into _drafts (these will be brought out and updated once we move to new r/extendr)
5. Simplified the landing page
6. Added dark mode
7. Switched to flatly bootswatch
8. Added _variables.yml to make it easier to update R, Rust, extendr, and rextendr version numbers everywhere they are referenced.
9. Added iconify quarto extension

[JosiahParry]

Suggested change

	- Every exported function in rextendr must include the following roxygen
	variables:
	roclets:

[JosiahParry]

examples are required by CRAN. this is not optional

[JosiahParry]

where did this go?

[JosiahParry]

This is not correct. These are run at the end of package installation

[JosiahParry]

I'm anti yaml.

Think we can change this to?

[versions]
r = "4.5"
rust = "1.71"
rextendr = "0.4"

Can read it with tomledit::read_toml(".variables.toml")

[kbvernon]

This is a Quarto feature that allows us to insert them into text using {{< var version.r >}} syntax. Should make it easier to update version numbers everywhere when that comes up. That said, we can use toml and do inline R code everywhere instead. Or neither! Whatever you think is best!

[JosiahParry]

Version is gonna trip claude up. This is the type of false flag that claude LOVES to get hung up on!

Suggested change

version: 0.8.1

[kbvernon]

I did not mean to commit CLAUDE.md. That's my bad. I think we should work on a Claude skills repo instead.

[JosiahParry]

Suggested change

version: 0.4.2.9000 (dev)

[JosiahParry]

lol

we need docs here:

For all new functionality we require tests to ensure they continue to work as intended. For bug fixes we require a test to cover the bug fix (if one didn't exist yet).

rextendr

• we use testthat to test functionality
• avoid adding new snaptshots whenever. snapshot tests are not indiciative of behavior

extendr-api

Two types of tests:

• rust test
  • see https://github.com/extendr/extendr/tree/main/extendr-api/tests for non-module-specific tests
  • do not use doc tests
  • otherwise include tests in a test module at the bottom of the module file
  • use test! macro see example https://github.com/extendr/extendr/blob/c1651f52dd94fdd56424d73b0b1951d3b94a364b/extendr-api/src/conversions/try_into_int.rs#L111
  • use with_r(|| {}) tests see https://github.com/extendr/extendr/blob/c1651f52dd94fdd56424d73b0b1951d3b94a364b/extendr-api/src/iter.rs#L246
• integration tests—these are to test the interface between rust and r these live in {extendrtests} package
  • particularly required for optional feature and integrations, handling of data across ffi bounds etc
  • see https://github.com/extendr/extendr/blob/c1651f52dd94fdd56424d73b0b1951d3b94a364b/tests/extendrtests/
  • example:
    • rust functions :https://github.com/extendr/extendr/blob/c1651f52dd94fdd56424d73b0b1951d3b94a364b/tests/extendrtests/src/rust/src/tuple_conversions.rs
    • called from testthat tests https://github.com/extendr/extendr/blob/c1651f52dd94fdd56424d73b0b1951d3b94a364b/tests/extendrtests/tests/testthat/test-tuples.R#L57

use the justfile to help run these with just document then just devtools-test and for rust tests just test and then also ensure that things are formatted with just fmt

[JosiahParry]

extendr-internals : lets add a callout note coming soon!