Update starlight docs 2

.github/workflows/pages.yml

@@ -22,6 +22,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          fetch-depth: 0
       - uses: oven-sh/setup-bun@0c5077e51419868618aeaa5fe8019c62421857d6 # v2.2.0
         with:
           bun-version: latest

README.md

@@ -40,7 +40,8 @@ export default defineConfig({
 ```
 
 That's it - the plugin wires in the theme CSS, self-hosted fonts, the branded
-`SiteTitle`/`Head`/`Footer` components, and a default GitHub social link.
+header, splash footer, and a default GitHub social link. Pass `nav` if you want
+top-level Docs / Guides / Reference tabs.
 
 ### Serving under a subpath
 
@@ -68,12 +69,15 @@ starlight({ plugins: [nebari({ logoHref: 'https://packs.nebari.dev/' })] })
 - **Brand colors** - nebari-design's OKLCH tokens mapped onto Starlight's theme
   variables in both light and dark mode. Starlight's WCAG-tuned gray scale is
   kept for accessible body and muted text.
-- **Typography** - Poppins for headings, Atkinson Hyperlegible for body, Fira
-  Code for code, all self-hosted (no external font requests at runtime).
+- **Typography** - Geist for body and headings, IBM Plex Mono for code, both
+  self-hosted (no external font requests at runtime).
 - **Logo, favicon, and footer** - the Nebari mark in the header, an inlined
-  symbol favicon, and a branded footer on every page.
-- **Search** - Starlight's built-in Pagefind, ready to merge additional pack
-  indexes for portal-wide multisite search.
+  symbol favicon, and a branded multi-column footer on splash pages (home, 404).
+  Doc pages with a sidebar end at their content.
+- **Nav tabs** - optional `nav` items render as header tabs and in the mobile
+  drawer. Omit the option and the header stays stock Starlight.
+- **Search** - Starlight's built-in Pagefind, styled to the Docs theme, ready to
+  merge additional pack indexes for portal-wide multisite search.
 
 Everything is overridable: your own `customCss`, `components`, and `social`
 entries are merged after the theme's, so a consumer always wins.
@@ -111,6 +115,19 @@ Run the test suite (builds the package and docs, then runs the tests):
 bun test
 ```
 
+The root `test` script covers `packages/starlight/test` and `docs/test` (the
+`--base /demo-pack` build). End-to-end checks live in `docs/`:
+
+```sh
+cd docs && bun run e2e
+```
+
+Regenerate the README screenshots (out of CI, 1440×900):
+
+```sh
+cd docs && bun run screenshots
+```
+
 ### Linting and formatting
 
 [Biome](https://biomejs.dev) handles both formatting and linting (including
@@ -161,9 +178,20 @@ This package follows [EffVer](https://jacobtomlinson.dev/effver/)
 your build unexpectedly:
 
 ```jsonc
-{ "dependencies": { "@nebari/starlight": "^0.1.0" } }
+{ "dependencies": { "@nebari/starlight": "^0.3.0" } }
 ```
 
+### 0.3.0
+
+EffVer meso. Four behaviours change without an opt-in:
+
+1. The footer no longer renders on doc pages — splash pages only.
+2. `lastUpdated` defaults to `true`, so a date appears on pages that had none.
+3. Nav tabs appear only if `nav` is set; absent, the header is byte-identical.
+4. Tables scroll rather than wrap. Long values scroll inside the cell or the
+   table instead of breaking across lines. With JavaScript disabled, a wide
+   table can overflow the page.
+
 ## Releasing
 
 Releases are published to npm automatically from GitHub Releases via

docs/astro.config.mjs

@@ -6,7 +6,16 @@ export default defineConfig({
   integrations: [
     starlight({
       title: 'Nebari Starlight',
-      plugins: [nebari()],
+      description: 'Shared Starlight theme for Nebari documentation sites.',
+      plugins: [
+        nebari({
+          nav: [
+            { label: 'Docs', href: '/' },
+            { label: 'Guides', href: '/guides/' },
+            { label: 'Reference', href: '/reference/configuration/' },
+          ],
+        }),
+      ],
       sidebar: [
         {
           label: 'Getting Started',
@@ -23,6 +32,7 @@ export default defineConfig({
         {
           label: 'Guides',
           items: [
+            { label: 'Overview', link: '/guides/' },
             {
               label: 'Authoring Content',
               link: '/guides/authoring-content/',
@@ -56,6 +66,7 @@ export default defineConfig({
               link: '/reference/configuration/',
             },
             { label: 'Components', link: '/reference/components/' },
+            { label: 'Kitchen Sink', link: '/reference/kitchen-sink/' },
           ],
         },
       ],

docs/e2e/screenshots.spec.ts

@@ -0,0 +1,23 @@
+import { expect, test } from '@playwright/test';
+
+test.describe('README screenshots', () => {
+  test.skip(
+    !process.env.SCREENSHOTS,
+    'set SCREENSHOTS=1 to regenerate README screenshots',
+  );
+
+  test('capture light and dark homepage screenshots', async ({ page }) => {
+    await page.setViewportSize({ width: 1440, height: 900 });
+    await page.goto('/');
+
+    for (const theme of ['light', 'dark'] as const) {
+      await page
+        .locator('html')
+        .evaluate((el, next) => el.setAttribute('data-theme', next), theme);
+      await expect(page.locator('.hero')).toBeVisible();
+      await page.screenshot({
+        path: `../.github/screenshots/${theme}.png`,
+      });
+    }
+  });
+});