Skip to content

Add a basic getting started configuration that doesn't need the setup #197

Description

@Treeed

Short description

The current description is too short to manually set up the plugin

What problem does this solve?

Some might not be able to or not want to execute the automagic setup (In my case I wasn't able to since I'm using OpenCode Desktop).
The readme helpfully suggests installing the plugin by adding it in opencode.json, but only references the gigantic reference for the configuration. Further down it is mentioned that the defaults are "sensible". What is not mentioned is that some settings, as far as I understand, must be configured to make the plugin useful.

Proposed solution

It would be helpful to add a short sample configuration that contains the settings that must be configured and a short comment saying what those are for.

Alternatives considered

Making the plugin automatically store a sample configuration in the config location if it doesn't exist, that the user can then alter

Area

CLI (setup / doctor)

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    feature requestNew feature or capability request

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions