search

crate / crash

Crash is an interactive CrateDB command line interface (CLI) SQL shell with autocompletion.
Apache License 2.0
48 stars 13 forks source link

Documentation feedback on /docs/run.rst #430

Closed msbt closed 7 months ago

msbt commented 8 months ago

Documentation feedback

Could we either use loading="lazy" or better/other compression (e.g. ezgif.com) for images? There's an 8MB gif which is quite big

amotl commented 7 months ago

Hi. Are you referring to the pager program animation?

https://cratedb.com/docs/crate/crash/en/latest/run.html#using-a-pager-program

I am so sorry. I just added the link without checking its resource size. We need to get rid of it again. Thanks!

msbt commented 7 months ago

Ah yes, that's the one, thanks for adding the anchor to clarify things! No need to get rid of it, if we could just add loading="lazy" as attribute, then it won't load until you scroll to that point.

amotl commented 7 months ago

Ah all right, thanks. Let's do it!

msbt commented 7 months ago

Just checked it out, it's embedded as a figure, couldn't find lazy loading options for that, what's the way to go here?

amotl commented 7 months ago

Is it possible to use another markup option, maybe from MyST, to embed the image? Otherwise, just use plain HTML, also after converting to Markdown?

msbt commented 7 months ago

@amotl could we just use the same syntax as in https://github.com/crate/crate-clients-tools/blob/main/docs/status.md?plain=1#L124 or does that work only with .md files?

amotl commented 7 months ago

What I've said: Just use plain HTML, right? May also work in .rst using .. raw:: html or such? Otherwise, convert to .md?

.. raw:: html

    <a href="https://example.org/">https://example.org/</a>
amotl commented 7 months ago

I see that run.rst has tables and stuff, so converting is probably not a one-minute job. So, let's try to use the raw data pass-through option of reStructuredText on this spot?