Skip to content

Clarify profile selection step in README and/or set a default option in the plugin #137

@g000m

Description

@g000m

When following the installation/usage instructions in the README, the step about selecting a profile currently provides the following guidance:

"Choose the desired profile. Press Ctrl to edit the profile before use. The item (Temporary profile) starts a terminal with a temporary profile."

However, when reaching this step in the actual modal, there are four choices presented. As a new user with no prior experience using this plugin, it’s unclear what each option means, and there are no hints about which option is recommended or safe to use first.

I stared at the choices for a minute or so before starting to test each one. What I wanted was my familiar shell, embedded in Obsidian. After testing the choices in order, the name darwinIntegratedDefault makes sense. But due to that tiny bit of friction, I almost decided not to bother.

Suggestions:

  • Clarify in the documentation what each of the four choices represents, ideally with a brief explanation for each.
    • For example, it would be helpful to know which profile is best for first-time users, which are user-configurable, and what selecting “Temporary profile” does.
  • Consider adding a note about a recommended or default option in the instructions.
  • Even better, the plugin could offer a sensible default selection or make the recommended choice more visually prominent for new users.

Clearer instructions or a built-in default would improve the first-time user experience significantly. Thank you!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions