You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Regardless of what revision of malli docs a user is looking at, the master revision is always used.
This is not an issue if folks are looking at the latest docs, but if looking at older docs (with tools like cljdoc), this is not so great.
Sound good? If so, lemme know, and I will create a PR.
The text was updated successfully, but these errors were encountered:
lread
changed the title
docs: consider referencing img with project relative paths
docs: consider referencing imgs with project relative paths
Jan 21, 2025
Currently...
In the malli docs, I see some lovely images.
But...
Some of these images are referenced absolutely, for example:
This means...
Regardless of what revision of malli docs a user is looking at, the
master
revision is always used.This is not an issue if folks are looking at the latest docs, but if looking at older docs (with tools like cljdoc), this is not so great.
Also...
I see a couple of images referenced like so:
Notice that this is not referencing the raw image. GitHub must compensate for this, but cljdoc does not, and these images are broken on cljdoc.
Proposal
I can take a sweep through the docs and fixup img refs for you.
For example this:
Would become:
And this:
Would become:
Sound good? If so, lemme know, and I will create a PR.
The text was updated successfully, but these errors were encountered: