-
Notifications
You must be signed in to change notification settings - Fork 29
Folders Doc #105
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
Merged
Merged
Folders Doc #105
Changes from 13 commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
2afc874
Initial attempt at doc
dhruvisompura 1ac18c7
Use sentence case for header
dhruvisompura f748bb4
Mention workspace switcher
dhruvisompura 91c6ed9
Reword template section paragraph
dhruvisompura 5fc2135
Add install link to quarto and run command
dhruvisompura 7a3862b
Fix formatting
dhruvisompura 15bed36
Mention command palette command
dhruvisompura 468aa40
Mention interpreter startup behavior
dhruvisompura 86aea6f
Update format and reword sections to match style guide
dhruvisompura f7296b7
Rewrite doc to focus on the "why" and expected behavior
dhruvisompura 0d04e99
Add section to bring up dialog
dhruvisompura 2483b9f
Fix linting errors
dhruvisompura 3764e38
Rework format
dhruvisompura f375bd5
Fix link format to match style guide
dhruvisompura File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| --- | ||
| title: "Folder Templates" | ||
| --- | ||
|
|
||
| The **New Folder from Template** feature helps you start new projects faster. Use this feature when you want to avoid manual setup, or ensure your project includes all recommended files and settings from the start. Instead of running multiple setup commands, you can make a few selections and Positron sets up everything for you automatically. This feature is ideal if you want to: | ||
|
|
||
| - Save time and avoid manual setup steps | ||
| - Start with a ready-to-use environment for your language or framework | ||
|
|
||
| ## Template contents | ||
|
|
||
| When you use a folder template, Positron creates a new project folder and configures the following items: | ||
|
|
||
| - **Environment directory:** A dedicated environment (such as `.venv` for Python) so you can install packages without affecting other projects. | ||
| - **Version control:** A `.git` directory and a `.gitignore` file with common patterns for your language or framework. | ||
| - **Directory structure:** Folders and files recommended for your template type, so your project is organized from the start. | ||
| - **Interpreter instance:** A new interpreter session starts automatically, ready for you to run code. | ||
| - **Editor:** An untitled file is opened in the editor, or a notebook is started with your chosen interpreter. | ||
|
|
||
| ## Using a template | ||
|
|
||
| To bring up the **New Folder from Template** dialog, select the "New" dropdown menu in the top-left or select the workspace switcher in the top-right. Select the "New Folder from Template" option from the menu to bring up the dialog. | ||
|
|
||
| You can also bring up the dialog by running the _Workspaces: New Folder from Template..._ command in the Command Palette. | ||
|
|
||
| After setup, your project is ready for development. You can open the folder in the current window or a new window. By default, Positron starts a session for the interpreter you selected. You can customize this behavior in the settings. For more details, see the [interpreter startup guide](interpreter-startup.qmd#configuring-interpreter-startup). | ||
|
|
||
| ## About Python templates | ||
|
|
||
| Python templates create a project with an isolated environment. This prevents conflicts between package versions and makes your work more reproducible. | ||
|
|
||
| You can choose to use a `pyproject.toml` file for advanced dependency management. | ||
|
|
||
| For more about environment managers, see the [supported environment managers guide](python-installations.qmd#supported-environment-managers). For details about Python interpreter discovery, see the [Discovering Python Installations guide](python-installations.qmd). | ||
|
|
||
| ## About R templates | ||
|
|
||
| R templates help you create projects with the right R version. | ||
|
|
||
| You can choose to use `renv` for reproducibility, but this is an advanced option. Most users should leave this box unchecked unless you are familiar with `renv` and need strict dependency management for your project. | ||
|
|
||
| `renv` is an R package that manages project dependencies. It creates a snapshot of the R packages in your project and saves them in a `renv.lock` file. This is helpful for power users who need to share projects or ensure exact package versions. You can learn more about renv [here](https://rstudio.github.io/renv/articles/renv.html). | ||
dhruvisompura marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure if we like this title but I wanted to keep it generic for when we eventually add more templates (built-in or even user supported). Not in love with this title so I'm open to ideas.
The doc feels a little incomplete to me but I can't figure out what's missing...