Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,34 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [1.0.0] - 2026-06-15
## [1.0.0] - 2026-06-18

### Added

- Added introductory context and visible `{toctree}` navigation blocks (`:titlesonly:`) across index pages.
- Added a redirect for the live patching architecture document.

### Changed

- Refactored documentation content for consistency, clarity, and alignment with the documentation gold standard.
- Standardized heading style to declarative noun-phrase headings and enforced sentence case.
- Replaced manual index link lists with structured toctree-based navigation and removed hidden toctrees.
- Restructured release notes pages by replacing collapsible sections with plain headings and simplifying landing-page navigation.
- Revised `README.md` and the documentation landing page to follow the Diátaxis model and present Livepatch with product-focused context.
- Improved server explanation and support documentation structure, including clearer diagnostic guidance.

### Fixed

- Corrected capitalization, proper nouns, hyphenation, and redirect target typos.
- Replaced non-compliant style patterns, including em dashes, contractions, latinisms, weak phrasing, and non-descriptive link text.
- Enforced Livepatch terminology rules (Livepatch as a proper noun, never a verb) and corrected all `on-premise` usage to `on-premises`.
- Normalized formatting for commands, file paths, and configuration values using inline code where appropriate.
- Preserved MyST frontmatter, Sphinx directives, and code blocks while applying structural and style cleanups.
- Added blank lines after MyST anchors, fixed heading levels in patch management docs, and updated documentation URLs and the custom wordlist.
- Excluded `_dev/*` from docs processing.
- Improved code highlighting contrast to resolve pa11y accessibility findings.

## [0.3.0] - 2026-06-15

### Added

Expand Down
80 changes: 78 additions & 2 deletions docs/_static/css/custom.css
Original file line number Diff line number Diff line change
@@ -1,3 +1,79 @@
.highlight pre span {
color: #111111 !important;
/* ==========================================================================
Accessible, Theme-Aware Pygments Token Configuration
========================================================================== */

/* 1. Define Accessible Color Palettes per Theme */
:root {
/* --- Light Mode Tokens (Passes WCAG AA 4.5:1 on white/light grey) --- */
--code-comment: #595959; /* Deep slate grey */
--code-keyword: #0056b3; /* Rich accessible blue */
--code-number: #b30000; /* Dark crimson */
--code-string: #246b24; /* Forest green */
--code-name: #6f42c1; /* Deep purple */
--code-operator: #212529; /* Near black */
}

/* Automatically switch variables if system preference or HTML attribute is dark */
@media (prefers-color-scheme: dark) {
:root {
/* --- Dark Mode Tokens (Passes WCAG AA 4.5:1 on charcoal/black) --- */
--code-comment: #a0a0a0; /* Soft silver-grey */
--code-keyword: #6ea8fe; /* Electric light blue */
--code-number: #ff8585; /* Pastel coral/red */
--code-string: #85ea85; /* Bright mint green */
--code-name: #b18cf5; /* Soft lavender */
--code-operator: #f8f9fa; /* Off-white */
}
}

/* Explicit fallback if your Sphinx theme uses a custom data attribute toggle */
html[data-theme="dark"] {
--code-comment: #a0a0a0;
--code-keyword: #6ea8fe;
--code-number: #ff8585;
--code-string: #85ea85;
--code-name: #b18cf5;
--code-operator: #f8f9fa;
}

/* ==========================================================================
2. Apply Variables to Pygments Classes
========================================================================== */

/* Comments (c, c1, cm, cp, etc.) */
.highlight .c, .highlight .ch, .highlight .cm, .highlight .cp,
.highlight .cpf, .highlight .c1, .highlight .cs {
color: var(--code-comment) !important;
}

/* Keywords (k, kc, kd, kn, kp, kr, kt) */
.highlight .k, .highlight .kc, .highlight .kd, .highlight .kn,
.highlight .kp, .highlight .kr, .highlight .kt {
color: var(--code-keyword) !important;
}

/* Numbers (m, mb, mf, mh, mi, mo, il) */
.highlight .m, .highlight .mb, .highlight .mf, .highlight .mh,
.highlight .mi, .highlight .mo, .highlight .il {
color: var(--code-number) !important;
}

/* Strings (s, sa, sb, sc, dl, sd, s2, se, sh, si, sx, sr, s1, ss) */
.highlight .s, .highlight .sa, .highlight .sb, .highlight .sc,
.highlight .dl, .highlight .sd, .highlight .s2, .highlight .se,
.highlight .sh, .highlight .si, .highlight .sx, .highlight .sr,
.highlight .s1, .highlight .ss {
color: var(--code-string) !important;
}

/* Names, Functions, and Classes (na, nb, nc, no, nd, ni, ne, nf, nl, nn, nt, nv) */
.highlight .na, .highlight .nb, .highlight .nc, .highlight .no,
.highlight .nd, .highlight .ni, .highlight .ne, .highlight .nf,
.highlight .nl, .highlight .nn, .highlight .nt, .highlight .nv {
color: var(--code-name) !important;
}

/* Operators & Words (ow, o) */
.highlight .ow, .highlight .o {
color: var(--code-operator) !important;
}
2 changes: 1 addition & 1 deletion docs/_templates/footer.html
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@
<a href="" class="js-revoke-cookie-manager muted-link">Manage your tracker settings</a>
{% if discourse %}
<div class="ask-discourse">
<a class="muted-link" href="href="{{ discourse }}">Ask a question on Discourse</a>
<a class="muted-link" href="{{ discourse }}">Ask a question on Discourse</a>
</div>
{% endif %}

Expand Down
Loading