Help Test the New Odoc-3-Powered Package Documentation Pages

Ecosystem
,
21

Btw. I was wondering if instead of having these source links you could not just hyperlink the identifier so that it jumps to the definition (and back from there as you suggest, which is something I still miss from merlin) . Slightly less discoverable but reduces the clutter, the CSS etc.

It feels natural to me:

  1. In the API docs clicking on a name generally leads you to its interface definition.
  2. If you click on the name of its interface definition it leads you to its implementation definition.
  3. If you click on the name of its implementation definition it leads you to its interface definition.

Seems more seamless code browsing to me.

4 Likes
22

That seems a good idea to try. I opened an issue on the odoc repo to remember it, once someone works on source rendering again!

1 Like
23

One wrinkle that we will need to work around is that it’s not a 1-to-1 mapping, as multiple places in the docs might link to the same implementation. We can know when that’s the case though, so maybe when it’s like that, when you click on the name of the implementation it comes up with a pop-up of places in the interface where it’s exposed?