posit-dev / posit-dev/positron

Increase consistency in UI around the concept of a "project"

Open
#4,787 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area: folder template area: ui frontend sharp-edge
Dominant language
TypeScript
Stars
4.3k
Forks
184
Avg merge
1d 11h
Merged PRs (30d)
206

Description

System details:

Positron and OS details:
Interpreter details:

Describe the issue:

Positron uses a few different terms to refer to a "project":

  • A Project, ie a project root folder that when created goes through the R, Python or other type flow
  • A folder, ie a project root folder that is blank at startup
  • A Workspace, ala VS Code

A VS Code "workspace" is usually just your project root folder. Workspace settings as well as debugging and task configurations are stored at the root in a .vscode folder. – VS Code docs

This can be a bit confusing in different ways:

  • "New Folder" already exists in the Explorer UI, but always refers to a subfolder from within a Workspace/root folder.
  • What is the difference between a Project or a Folder? Does one contain a dot-file?
  • RStudio users expecting equivalent to .Rproj
  • VS Code users expecting a "Workspace"

Expected or desired behavior:

It might be preferable to settle on a single term, New Project or New Blank Project to replace the "New Project" and "New Folder" flows. Alternatively "New Workspace" or "New Blank Workspace"

Explorer flow

We also likely want to add a "New Project/Workspace" button to the Explorer, rather than relying on Open Folder:

Screen Shot 2024-09-23 at 7 11 40 PM
Existing UI

Otherwise, there are a number of areas where the Folder name is used:

Screen Shot 2024-09-23 at 7 11 17 PM Screen Shot 2024-09-23 at 7 11 57 PM Screen Shot 2024-09-23 at 7 11 46 PM Screen Shot 2024-09-23 at 7 11 25 PM

Were there any error messages in the UI, Output panel, or Developer Tools console?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the Explorer UI and the existing New Project, New Folder, Open Folder, and Workspace terminology described in the issue. First resolve which single term and flows maintainers want; done means the selected terminology is applied consistently across the referenced UI areas.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
desktop-dev, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.