spectral-intellij-plugin icon indicating copy to clipboard operation
spectral-intellij-plugin copied to clipboard

Published 20 hours ago • verified publisher icon SchwarzIT

Unclear Instructions for plugin usage in the README

Open s-yanev opened this issue 1 year ago • 3 comments

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.

s-yanev avatar Nov 29 '23 10:11 s-yanev