patches and low-level development discussion
 help / color / mirror / code / Atom feed
From: Valentin Gagarin <valentin@gagarin.work>
To: devel@spectrum-os.org
Cc: Valentin Gagarin <valentin@gagarin.work>
Subject: [PATCH 0/3] Documentation: render all pages in one style
Date: Mon,  8 Jun 2026 18:49:25 +0200	[thread overview]
Message-ID: <20260608164938.290202-1-valentin@gagarin.work> (raw)

This is a textually large but mostly mechanical change:
- Use the same stylesheet for all pages rendered with Jekyll
- Render a sitemap
- Render breadcrumbs on each page
- Drop Just the Docs
- Provide a minimal admonition style

I adapted some of the page titles to read better within the sitemap and
the breadcrumbs, by removing the "Spectrum " prefix.

Valentin Gagarin (3):
  Documentation: align Jekyll page style to rest of website
  Documentation: drop Just the Docs
  Documentation: uniform navigation across all pages

 Documentation/Gemfile                         |  1 -
 Documentation/Gemfile.lock                    | 12 +---
 Documentation/_config.yml                     |  7 ---
 Documentation/_includes/breadcrumb.html       | 23 ++++++++
 Documentation/_includes/footer_custom.html    |  8 ++-
 Documentation/_includes/sitemap.html          | 55 ++++++++++++++++++
 Documentation/_includes/title.html            | 13 -----
 Documentation/_layouts/page.html              | 28 +++++++++
 Documentation/_plugins/site_title_link.rb     | 10 ----
 Documentation/_sass/custom/custom.scss        | 43 --------------
 Documentation/bibliography.html               | 38 ++----------
 Documentation/contributing.html               | 38 ++----------
 Documentation/design.html                     | 38 ++----------
 Documentation/doc/about/architecture.adoc     |  1 -
 Documentation/doc/about/index.adoc            |  1 -
 Documentation/doc/about/requirements.adoc     |  1 -
 Documentation/doc/contributing/b4.adoc        |  2 -
 .../contributing/building-documentation.adoc  |  1 -
 .../doc/contributing/communication.adoc       |  1 -
 .../doc/contributing/first-patch.adoc         |  2 -
 Documentation/doc/contributing/index.adoc     |  1 -
 Documentation/doc/contributing/replying.adoc  |  2 -
 .../doc/contributing/reviewing-patches.adoc   |  2 -
 .../doc/contributing/testing-patches.adoc     |  2 -
 .../contributing/working-with-patches.adoc    |  2 -
 .../contributing/writing_documentation.adoc   |  3 +-
 ...architecture-decision-record-template.adoc |  2 +-
 .../decisions/001-host-update-mechanism.adoc  |  2 -
 .../doc/decisions/002-install-options.adoc    |  2 -
 .../doc/decisions/003-partitioning.adoc       |  2 -
 .../004-data-at-rest-encryption.adoc          |  2 -
 .../005-virtual-machine-monitor.adoc          |  2 -
 .../doc/decisions/006-drivers-on-host.adoc    |  2 -
 .../decisions/007-usb-virtual-machines.adoc   |  2 -
 ...008-inter-vm-communication-mechanisms.adoc |  2 -
 Documentation/doc/decisions/index.adoc        |  2 -
 .../doc/development/build-configuration.adoc  |  1 -
 .../doc/development/built-in-vms.adoc         |  1 -
 Documentation/doc/development/checks.adoc     |  1 -
 Documentation/doc/development/debugging.adoc  |  1 -
 Documentation/doc/development/index.adoc      |  1 -
 .../doc/development/persistent-storage.adoc   |  1 -
 Documentation/doc/development/release.adoc    |  1 -
 Documentation/doc/development/updates.adoc    |  1 -
 .../doc/development/uuid-reference.adoc       |  1 -
 Documentation/doc/index.adoc                  | 11 +++-
 .../doc/installation/binary-cache.adoc        |  1 -
 .../doc/installation/getting-spectrum.adoc    |  1 -
 Documentation/doc/installation/index.adoc     |  1 -
 .../using-spectrum/creating-custom-vms.adoc   |  1 -
 Documentation/doc/using-spectrum/index.adoc   |  1 -
 .../doc/using-spectrum/running-vms.adoc       |  1 -
 .../doc/using-spectrum/vm-file-access.adoc    |  1 -
 Documentation/gemset.nix                      | 33 -----------
 Documentation/impressum.html                  | 35 ++---------
 Documentation/index.html                      | 33 ++---------
 Documentation/logo/index.html                 | 38 ++----------
 Documentation/motivation.html                 | 38 ++----------
 Documentation/sitemap.adoc                    |  8 +++
 .../software/cloud-hypervisor/index.html      | 39 ++-----------
 Documentation/software/index.html             | 38 ++----------
 Documentation/style.css                       | 58 +++++++++++++++++++
 62 files changed, 234 insertions(+), 468 deletions(-)
 create mode 100644 Documentation/_includes/breadcrumb.html
 create mode 100644 Documentation/_includes/sitemap.html
 delete mode 100644 Documentation/_includes/title.html
 create mode 100644 Documentation/_layouts/page.html
 delete mode 100644 Documentation/_plugins/site_title_link.rb
 delete mode 100644 Documentation/_sass/custom/custom.scss
 create mode 100644 Documentation/sitemap.adoc

-- 
2.51.2


             reply	other threads:[~2026-06-08 16:50 UTC|newest]

Thread overview: 28+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-06-08 16:49 Valentin Gagarin [this message]
2026-06-08 16:49 ` [PATCH 1/3] Documentation: align Jekyll page style to rest of website Valentin Gagarin
2026-06-08 16:49 ` [PATCH 2/3] Documentation: drop Just the Docs Valentin Gagarin
2026-06-08 16:49 ` [PATCH 3/3] Documentation: uniform navigation across all pages Valentin Gagarin
2026-06-08 16:49 ` [PATCH 1/3] Documentation: align Jekyll page style to rest of website Valentin Gagarin
2026-06-09 11:45   ` Alyssa Ross
2026-06-10 12:12     ` Valentin Gagarin
2026-06-10 12:23       ` Alyssa Ross
2026-06-08 16:49 ` [PATCH 2/3] Documentation: drop Just the Docs Valentin Gagarin
2026-06-09 11:43   ` Alyssa Ross
2026-06-08 16:49 ` [PATCH 3/3] Documentation: uniform navigation across all pages Valentin Gagarin
2026-06-09 11:54   ` Alyssa Ross
2026-06-11  6:37 ` [PATCH v2 1/3] Documentation: align Jekyll page style to rest of website Valentin Gagarin
2026-06-11  6:37   ` [PATCH v2 2/3] Documentation: drop Just the Docs Valentin Gagarin
2026-06-11  6:37   ` [PATCH v2 3/3] Documentation: uniform navigation across all pages Valentin Gagarin
2026-06-12  8:44     ` Alyssa Ross
2026-06-12  8:27   ` [PATCH v2 1/3] Documentation: align Jekyll page style to rest of website Alyssa Ross
2026-06-16  9:35 ` [PATCH v3 0/3] Documentation: render all pages in one style Valentin Gagarin
2026-06-16  9:35   ` [PATCH v3 1/3] Documentation: align Jekyll page style to rest of website Valentin Gagarin
2026-06-16 11:49     ` Alyssa Ross
2026-06-16 12:02       ` Valentin Gagarin
2026-06-17 10:48     ` Alyssa Ross
2026-06-16  9:35   ` [PATCH v3 2/3] Documentation: drop Just the Docs Valentin Gagarin
2026-06-17 10:48     ` Alyssa Ross
2026-06-16  9:35   ` [PATCH v3 3/3] Documentation: uniform navigation across all pages Valentin Gagarin
2026-06-16 12:01     ` Alyssa Ross
2026-06-17 10:48     ` Alyssa Ross
2026-06-16 12:01   ` [PATCH v3 0/3] Documentation: render all pages in one style Alyssa Ross

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260608164938.290202-1-valentin@gagarin.work \
    --to=valentin@gagarin.work \
    --cc=devel@spectrum-os.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://spectrum-os.org/git/crosvm
	https://spectrum-os.org/git/doc
	https://spectrum-os.org/git/mktuntap
	https://spectrum-os.org/git/nixpkgs
	https://spectrum-os.org/git/spectrum
	https://spectrum-os.org/git/ucspi-vsock
	https://spectrum-os.org/git/www

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).