RxInfer.jl
RxInfer.jl copied to clipboard
biaslab
Improve linking between examples and docs
Hi! Based on a simple search, it looks like:
- In RxInferExamples, there are 5 links to the documentation.
- In the RxInfer docs, there are 0 links to specific examples (only to the examples homepage).
I think creating more links between examples and docs has a lot of potential to make RxInfer more accessible, for example:
-
Example linking to Docs:
- Prerequisites (before reading an otherwise intimidating example)
- Learn more, dig deeper
-
Docs linking to example:
- See it in action
- Showcase different uses of one function
It also makes the learning experience more fun – you can jump around and explore. You see what's possible and how different parts are connected.
I like the idea! though I’m not entirely sure how it would work in practice. It’s definitely a good challenge for someone. The main issue is that our examples are auto-generated from Jupyter notebooks and have semi-stable URLs. We could hard-code some of these URLs in the RxInfer docs, but only if we can enforce a build failure whenever a link breaks (for instance, if an example file gets renamed).
I think this might have been solved, we now have a banner on the top of the page and also a note in the search box, @fonsp can you check it? Maybe we can add smth more
Hi! We are moving to a cleaner Epic -> Feature -> Task issue hierarchy to better organize our backlog. This issue is currently either underspecified or not tagged appropriately.
To keep this issue open, please do the following within the next 7 days (by 25-11-2025):
- Update/Replace: Ensure the description is clear and actionable.
- Tag Correctly:For Tasks/Features, add the correct label (e.g., feature, task) AND include a link to the Parent Epic or Feature it belongs to.
- For Bugs, add the Bug label. (Bugs do not require a parent link.)
Issues not updated, linked, or tagged correctly by the deadline will be closed and purged.
Thank you for helping us clean up and organize our backlog!
