Redocly / redocly-vs-code

Redocly VS Code extension
35 stars 6 forks source link

update README redocly.yaml example to match latest version #46

Closed dverbovyi closed 1 year ago

dverbovyi commented 1 year ago

Hi, the tool is pretty awesome, keep up the good work!

This is my first experience and I've just playing it around.

I was trying to follow the description inside vs-code after extension installation. The extension didn't prompt me to create .readocly.yaml, so I did it manually by copy-pasting the content from the example, which seems isn't up to date, as I got this:

Screenshot 2023-05-15 at 22 10 52

The correct version of example I found by browsing thought the website

We all often forget to update our docs, so I hope this PR will be useful 😁

RomanHotsiy commented 1 year ago

Thanks, @dverbovyi!

RomanHotsiy commented 1 year ago

@dverbovyi could you actually update it a bit more by changing .redocly.yaml to redocly.yaml (the one with the dot is legacy).

Thanks. We can update it ourselves too.

cc @tatomyr

dverbovyi commented 1 year ago

sure, updated

you're welcome