Skip to content

Unclear Instructions for plugin usage in the README #115

Open
@s-yanev

Description

Summary:
The current README documentation for the Spectral plugin lacks comprehensive guidance on setting up and using the plugin.

Detailed Description:
I have recently installed the Spectral plugin on IntelliJ IDEA version 2023.2.5 to lint OpenAPI specification files. While the installation and basic configuration were straightforward, I encountered difficulties with enabling and utilizing the automatic linting feature. Despite following the available instructions in the README, the automatic linting does not seem to be operational.

I believe more detailed and step-by-step documentation, could greatly benefit users of the plugin. Also providing screenshots on how to trigger the lint process would be nice.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions