Skip to content

Add visual guide#1656

Open
hippalectryon-0 wants to merge 3 commits intoQubesOS:mainfrom
hippalectryon-0:visual_guide
Open

Add visual guide#1656
hippalectryon-0 wants to merge 3 commits intoQubesOS:mainfrom
hippalectryon-0:visual_guide

Conversation

@hippalectryon-0
Copy link

See QubesOS/qubes-issues#10765

Note: GenAI was used to replicate the template of https://www.qubes-os.org/doc/visual-style-guide/

@ben-grande
Copy link
Contributor

@parulin
Copy link
Contributor

parulin commented Mar 11, 2026

I think this is a regression:

  • take a look at the data of the page on QubesOS/qubesos.github.io ... How are we supposed to edit this huge HTML content with the current solution?
  • the epub build is incorrect. Is the PDF version working?
  • why include CSS fonts?
  • are all those !important really necessary?

I would prefer a restructuredtext version, using container or class directives, and converting the font samples to images. The only important thing is to keep all the colors next to the others.

@hippalectryon-0
Copy link
Author

I removed the inserted html, let me know what you think.

why include CSS fonts?

Because I didn't find a cdn that provides ostrich-* fonts

@parulin
Copy link
Contributor

parulin commented Mar 12, 2026

That's better!

Including any CSS font, even with a CDN is overkill. Using an image instead would be more appropriate.

@hippalectryon-0
Copy link
Author

I switched to static images. It's not perfect (should ideally be .svg instead of .png) but I'd argue it's good enough and we can always improve it later on.


html_static_path = ['attachment/doc']

html_css_files = [
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In other pending PR, I used the following:

html_static_path = ['_static']
html_css_files = ['css/custom.css']

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure I understand what changes you want here

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would like you to move the CSS in the _static directory and update conf.py according to that, like what I did here:

https://github.com/QubesOS/qubes-doc/pull/1547/changes

@parulin
Copy link
Contributor

parulin commented Mar 13, 2026

I switched to static images. It's not perfect (should ideally be .svg instead of .png) but I'd argue it's good enough and we can always improve it later on.

I think PNGs are better than SVG here. The images could have a transparent background but it is good enough 👍

@ben-grande
Copy link
Contributor

Look at the space between the color image, the name and the code:

It seems there is too much space between the color code and the color name. This PR made the color image and color name closer, looks better.

@hippalectryon-0
Copy link
Author

Fixups should have fixed most comments - I will squash once deemed ready to merge.


.. container:: swatch-item

.. image:: /attachment/doc/visual_guide/swatches/q-gray-base.svg
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not using an empty :alt: produces a bad result with Sphinx. You need to be explicit, just like the font images above.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants