posit-dev / positron

Positron, a next-generation data science IDE
https://positron.posit.co
Other
2.82k stars 90 forks source link

Devise an acceptable way of using links to the settings editor in our documentation #5443

Open jennybc opened 8 hours ago

jennybc commented 8 hours ago

VS Code and, therefore, Positron has a special URI scheme that allows the opening of files, folders, and settings in the product:

https://code.visualstudio.com/docs/editor/command-line#_opening-vs-code-with-urls

You can use the URL in applications such as browsers or file explorers that can parse and redirect the URL.

In https://github.com/posit-dev/positron-website/pull/21, I included such links when documenting the settings positron.r.customRootFolders and positron.r.customBinaries, but then removed them based on review, because they don't work if someone is reading the documentation on, say their phone (or, more generally, a machine that doesn't have Positron).

An example of such a link: positron://settings/positron.r.customRootFolders

These links could be extremely useful in documentation in terms of taking users straight to the setting versus explaining how to navigate to the setting via the UI.

This issue is for us to figure out styling and behaviour that would allow us to use these links in the future.