File Tree Diff: small documentation to mention the file selector #12011
Conversation
Briefly explanation about how to use visual doc diff. Closes #12009
| Once there, you can toggle it on/off by pressing the :guilabel:`Show diff` link from the UI element to show all the chunks and their differences highlighted with red/green background colors. | ||
| Besides, you can jump between each of these chunks by clinking on the up/down arrows. | ||
|
|
||
| All the available configuration for the visual diff addon can be found under :guilabel:`Settings > Addons > Visual diff` in the :term:`dashboard`. |
There was a problem hiding this comment.
It would be nice if we could link to this directly with a URL arg 🤔
There was a problem hiding this comment.
Hrm, I think Sphinx doesn't allow us to use guilabel with a link: https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-guilabel
Do we have an example of what you would like to render? BTW, the link where would point to? I suppose we would need something like "Choose organization" feature but for projects.
|
|
||
| * **Tables** are shown to have changes when they may not have changed. This is due to do subtly in how HTML tables are rendered, and will be fixed in a future version. | ||
| * **Invisible changes** sometimes are marked as diff due than the underlying HTML changed, but there is no visual change. This could happen if the URL of a link changed, for example. | ||
| * **Chunks background is incorrect** when we are unable to detect the correct main parent element for the chunk. |
There was a problem hiding this comment.
I'm not 100% sure what this is saying? Will the background be missing or smaller than expected?
There was a problem hiding this comment.
When we don't detect the immediate main parent element of the chunk, we keep going up to the parent of the parent and so on. It could happens that the highlighted node ends up being the whole document.
I tried to find a quick example, but I wasn't able to. However, I know this happens sometimes.
There was a problem hiding this comment.
Seems like we just shouldn't highlight in that case? Maybe limit parent looking to 2-3 elements and explicitly avoid things that look like content divs.
There was a problem hiding this comment.
Yeah, we will fix this issue. I tried a few different stuffs already but none worked reliably.
I think it's fine to document it as a known bug/issue for now.
Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com>
Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com>
Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com>
Briefly explanation about how to use visual doc diff.
Closes #12009
📚 Documentation previews 📚
docs): https://docs--12011.org.readthedocs.build/en/12011/dev): https://dev--12011.org.readthedocs.build/en/12011/