ribbity-org / ribbity

Software to turn GitHub issue trackers into mkdocs Web sites.
https://ribbity-org.github.io/ribbity-docs/
Other
8 stars 2 forks source link

provide tools for managing links into ribbity sites from other sites #17

Open ctb opened 2 years ago

ctb commented 2 years ago

e.g. it would be nice to provide a ribbity-based CLI that verified (or translated?) links in the sourmash documentation into sourmash-examples.

One specific set of use cases is where we want to refer to either a specific example, or a whole category of issues, in the sourmash docs. it would be ideal to be able to manage that list nicely, so that it can be checked, and updated, and maybe a summary of all such interlinks could be provided (so that it is ~straightforward to verify that the links are up to date).

not 100% sure how this would work.

I've been thinking about adding "triangle reveal" functionality to the sourmash docs so that you can see "examples related to this documentation".

ultimately I guess this could be a readthedocs plugin, if it was useful enough.