[docs] Link to docs on PRs

Open oliviertassinari opened this issue 1 year ago • 1 comments

Working on https://github.com/mui/base-ui/pull/393, I have noticed that we are missing the easy access link to the docs.

I faced a bit working on this https://github.com/danger/danger-js/issues/1180. I removed the formatFileToLink() import; The logic feels broken anyway, at least, in my view. In the end, this PR is close to what MUI X's uses. I think it will be great to normalize the markdown output at one point. I don't think it's great right now, but it's a larger scope. I'm going with the bare minimum possible change, to still place us a step forward.

I think we will need to aggregate bundle size reports too in the future: https://github.com/mui/base-ui/issues/201.

May 04 '24 14:05 oliviertassinari

Netlify deploy preview

https://deploy-preview-394--base-ui.netlify.app/

Generated by :no_entry_sign: dangerJS against 7fef0d15bbbe4b0797b5423fedba4fd603fcf987

May 04 '24 14:05 mui-bot