diff --git a/docs/book.toml b/docs/book.toml index d9129e2..2bf715b 100644 --- a/docs/book.toml +++ b/docs/book.toml @@ -1,5 +1,5 @@ [book] -title = "Kaptan Developer Manual" +title = "Kaptan documentation" description = "Architecture, board bring-up, simulation, and contributor guidance for Kaptan." authors = ["Kaptan contributors"] language = "en" diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 356a602..1a4381c 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -1,6 +1,6 @@ # Summary -- [Kaptan Developer Manual](index.md) +- [Kaptan documentation](index.md) - [Getting started](getting-started.md) - [Architecture](architecture.md) - [Safety boundary](safety-boundary.md) diff --git a/docs/theme/lore.css b/docs/theme/lore.css index e80a272..d3826cb 100644 --- a/docs/theme/lore.css +++ b/docs/theme/lore.css @@ -1,6 +1,6 @@ /* - * Static, text-first presentation inspired by lore.kernel.org. - * Palette: Orkavian's published black, silver, and green site tokens. + * A static documentation layout: kernel-docs navigation with lore-like + * restraint. Colours follow Orkavian's black, silver, and green palette. */ :root, html.light, @@ -8,18 +8,18 @@ html.rust, html.coal, html.navy, html.ayu { - --background: #050505; - --background-secondary: #0a0a0a; - --text: #cccccc; - --text-muted: #888888; - --accent: #00ff41; - --border: #333333; + --kaptan-background: #050505; + --kaptan-surface: #0a0a0a; + --kaptan-text: #cccccc; + --kaptan-muted: #888888; + --kaptan-accent: #00ff41; + --kaptan-border: #333333; } html, body { - background: var(--background); - color: var(--text); + background: var(--kaptan-background); + color: var(--kaptan-text); font-family: "Roboto Mono", ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", monospace; font-size: 15px; @@ -33,48 +33,87 @@ body { transition: none !important; } -/* Replace mdBook's interactive chrome with a quiet, static masthead. */ -#mdbook-sidebar, +/* The book remains static: no help, theme picker, resizing, or search UI. */ +#mdbook-help-container, #mdbook-sidebar-toggle-anchor, #mdbook-menu-bar-hover-placeholder, -#mdbook-help-container, #mdbook-menu-bar .left-buttons, -#mdbook-menu-bar .right-buttons { +#mdbook-menu-bar .right-buttons, +#mdbook-sidebar-resize-handle { display: none !important; } -#mdbook-page-wrapper, -.page-wrapper, -.page { - margin-left: 0 !important; - transform: none !important; -} - #mdbook-menu-bar { - background: var(--background-secondary); - border-bottom: 1px solid var(--border); - display: block; + background: var(--kaptan-surface); + border-bottom: 1px solid var(--kaptan-border); height: auto; margin: 0; min-height: 0; - padding: 0.55rem max(1rem, calc((100vw - 78ch) / 2)); + padding: 0.65rem 1.25rem; position: static; } #mdbook-menu-bar .menu-title { - color: var(--text); + color: var(--kaptan-text); font-family: inherit; font-size: 0.85rem; font-weight: 700; letter-spacing: 0.08em; - line-height: 1.4; + line-height: 1.35; text-transform: uppercase; } +#mdbook-sidebar { + background: var(--kaptan-surface); + border-right: 1px solid var(--kaptan-border); + box-sizing: border-box; + display: none !important; + overflow-y: auto; +} + +.sidebar-scrollbox { + padding: 0.75rem 0; +} + +.sidebar-scrollbox ol { + list-style: none; + margin: 0; + padding: 0; +} + +.sidebar-scrollbox .chapter-item { + margin: 0; +} + +.sidebar-scrollbox .chapter-item a { + color: var(--kaptan-text); + display: block; + font-size: 0.85rem; + line-height: 1.45; + padding: 0.3rem 1rem; + text-decoration: none; +} + +.sidebar-scrollbox .chapter-item a:hover, +.sidebar-scrollbox .chapter-item a.active { + background: transparent; + color: var(--kaptan-accent); +} + +.sidebar-scrollbox .section .chapter-item a { + padding-left: 2rem; +} + +.sidebar-scrollbox strong { + color: var(--kaptan-muted); + font-weight: 400; +} + .content { + box-sizing: border-box; margin: 0 auto; - max-width: 78ch; - padding: 1.75rem 1rem 3rem; + max-width: 84ch; + padding: 2rem 1.5rem 3rem; } .content main { @@ -86,19 +125,19 @@ h1, h2, h3, h4 { - color: var(--text); + color: var(--kaptan-text); font-family: inherit; font-weight: 700; line-height: 1.35; } h1 { - font-size: 1.25rem; + font-size: 1.35rem; margin: 0 0 1.25rem; } h2 { - border-bottom: 1px solid var(--border); + border-bottom: 1px solid var(--kaptan-border); font-size: 1rem; margin: 2rem 0 0.75rem; padding-bottom: 0.35rem; @@ -111,7 +150,7 @@ h4 { } a { - color: var(--accent); + color: var(--kaptan-accent); text-decoration: underline; text-underline-offset: 0.15em; } @@ -146,14 +185,14 @@ kbd { } code { - background: var(--background-secondary); - color: var(--text); + background: var(--kaptan-surface); + color: var(--kaptan-text); padding: 0.05rem 0.25rem; } pre { - background: var(--background-secondary); - border: 1px solid var(--border); + background: var(--kaptan-surface); + border: 1px solid var(--kaptan-border); overflow-x: auto; padding: 0.75rem; } @@ -169,31 +208,24 @@ table { th, td { - border: 1px solid var(--border); + border: 1px solid var(--kaptan-border); padding: 0.35rem 0.5rem; text-align: left; } th { - color: var(--text); font-weight: 700; } blockquote { - border-left: 2px solid var(--border); - color: var(--text-muted); + border-left: 2px solid var(--kaptan-border); + color: var(--kaptan-muted); margin-left: 0; padding-left: 0.8rem; } -hr { - border: 0; - border-top: 1px solid var(--border); - margin: 1.5rem 0; -} - .nav-wrapper { - border-top: 1px solid var(--border); + border-top: 1px solid var(--kaptan-border); margin-top: 2rem; padding-top: 0.75rem; } @@ -203,7 +235,33 @@ hr { } .nav-chapters a { - color: var(--accent); + color: var(--kaptan-accent); +} + +@media (min-width: 900px) { + #mdbook-sidebar { + bottom: 0; + display: block !important; + left: 0; + position: fixed; + top: 0; + transform: none !important; + width: 17.5rem; + } + + #mdbook-page-wrapper, + .page-wrapper { + margin-left: 17.5rem !important; + transform: none !important; + } +} + +@media (max-width: 899px) { + #mdbook-page-wrapper, + .page-wrapper { + margin-left: 0 !important; + transform: none !important; + } } @media print { @@ -213,8 +271,9 @@ hr { color: #000000; } - #mdbook-menu-bar { - display: none; + #mdbook-menu-bar, + #mdbook-sidebar { + display: none !important; } a {