Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve Usage section in README.md #6

Open
TheWall89 opened this issue Feb 12, 2020 · 2 comments · May be fixed by #8
Open

Improve Usage section in README.md #6

TheWall89 opened this issue Feb 12, 2020 · 2 comments · May be fixed by #8

Comments

@TheWall89
Copy link

Detailed description

Improve the Usage section in the README with a better description on how to use this plugin. Maybe I'm dumb, but I spent several minutes looking for the small Redoc tab at the bottom left of my OpenAPI file. A short description of the added tab and/or a screenshot would be appreciated.

Context

Ease the plugin adoption from new users.

Your environment

  • Version used: Jetbrains JRE, IntelliJ IDEA 2019.3
  • Operating system and version: Archlinux
@andrei572
Copy link

andrei572 commented Aug 14, 2020 •
edited
Loading

I still can't figure out how to run the plugin on a Mac.

@TheWall89
Copy link
Author

I still can't figure out how to run the plugin on a Mac.

Open your YAML/Json OpenAPI specification. Check the bottom left of the editor tab and click on the Redoc button. Screenshot attached.
redoc

@TheWall89 TheWall89 linked a pull request Aug 23, 2020 that will close this issue
Open
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improve usage documentation TheWall89/intellij-redoc
2 participants
@TheWall89 @andrei572