devdocs icon indicating copy to clipboard operation
devdocs copied to clipboard

Copy/paste settings

Open svenssonaxel opened this issue 1 year ago • 2 comments

Feature request

Let the user access a text representation of their settings.

Summary

The desired doc selection and other settings are likely to be the same across machines, browser profiles etc. A way to copy/backup/export and paste/restore/import those settings would make devdocs easier to make your own.

Examples

Example designs for this feature:

  • Put two buttons in settings, one for Copy and one for Paste. Copy will put a serialized representation of all settings into the clipboard and confirm to the user. Paste will read the clipboard, parse/validate the payload and then ask the user whether they're sure they want to overwrite settings.
  • Put two buttons in settings, one for downloading a settings file and one for importing settings from a file.
  • Put one button in settings that puts a setting restore link into the clipboard. If the user navigates to this URI, they are asked to confirm overwriting the settings.
  • Put a textarea in settings that holds a JSON or YAML representation of all settings. All settings can be edited as normal or in the textarea, and the two representations will stay in sync.

svenssonaxel avatar Sep 21 '22 12:09 svenssonaxel

Export/Import of preferences is available via buttons on https://devdocs.io/settings. Why is a separate copy/paste to/from clipboard needed?

{"theme":"default","noAutofocus":"1","docs":"python~3.11"}

simon04 avatar Nov 04 '22 20:11 simon04

Given the settings JSON is relatively small, it can be easier for some users to just copy/paste them to/from somewhere else (e.g. Google Keep, or even from a chat window).

denilsonsa avatar Jan 08 '23 10:01 denilsonsa