Link external documentation and render description as markdown

dweber019 / backstage-plugins

A collection of Backstage plugins

MIT License

20 stars 7 forks source link

Link external documentation and render description as markdown #24

Closed jeffersongirao closed 2 months ago

jeffersongirao commented 2 months ago

Hey there @dweber019!

Thanks a lot for your work on the Spectral Lint Plugin for Backstage! 🙌

In this PR I'm proposing to render a documentation URL link when that is available. Also to render the description as markdown (I think that is how some rules are documented out there, the spotlight one was added as an example).

Please let me know your thoughts on that! 🙂

dweber019 commented 2 months ago

@jeffersongirao Thanks 🙏 will have a look at this over the weekend.

Btw totally agree as I created https://github.com/stoplightio/spectral/pull/2443 😉

jeffersongirao commented 2 months ago

@dweber019 thanks for the quick reply! I've just added the changeset 👍.

dweber019 commented 2 months ago

@jeffersongirao Should be available in a few minutes.