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

Documentation feedback #109

Closed
wants to merge 7 commits into from
Closed

Conversation

philipp-baumann
Copy link
Collaborator

No description provided.

README.Rmd Outdated Show resolved Hide resolved
README.Rmd Outdated Show resolved Hide resolved
README.Rmd Outdated Show resolved Hide resolved
README.Rmd Outdated Show resolved Hide resolved
README.Rmd Outdated Show resolved Hide resolved
README.Rmd Show resolved Hide resolved
@philipp-baumann
Copy link
Collaborator Author

philipp-baumann commented Jan 27, 2024

@b-rodrigues i first thought we could include something like this:

"### Path of Nix installation not in `PATH`

When using RStudio Desktop on macOS, you typically launch it from the Applications folder. 
However, RStudio currently lacks an option to start an integrated R session via a shell startup
 on macOS (in contrast to Linux, where this is the case). As a result, key environmental variables
 for UNIX systems, like PATH, are not be properly loaded from your default shell (e.g., zsh, via ~/.zshrc). 
Also, RStudio overwrites a `PATH` variable set via `.Rprofile` or `.Renviron` with its own defaults, 
which makes it impossible to find Nix and standard Nix tools like `nix-build`.  It's worth noting that this
 doesn't impact rix::rix(), which generates R expressions and doesn't require a Nix installation. As a 
workaround, we have added mechanisms in `nix_build()` and `with_nix()` that append the path of 
the Nix store to the `PATH` variable in an active session automatically (via `Sys.setenv()`, when you
use RStudio on macOS

but then, it might be also quite a bit of an overhead of information, since it gets taken care of without user intervention. Shall we mention still or we leave it, what's your opinion?

@b-rodrigues
Copy link
Contributor

Maybe we could add this all the way at the end, with a title like "why do we need this?" or something. And start with a first sentence such as: "only read this if you're interested in the why". This could be interesting info for some users, and also for us in 3 years when we'll have forgotten why we do that :D

This was referenced Jan 27, 2024
@philipp-baumann
Copy link
Collaborator Author

addressed in #130

@philipp-baumann philipp-baumann deleted the documentation-feedback branch February 3, 2024 02:21
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