Update starlight docs - #27
Conversation
|
@jbouder looks like your working with a stale build? I dont see many of the changes. that being said there is a bug with the footer, that i'll push a fix for. the designs only have the footer on the main page. the alerts styling is one of the first things i have in the second pr, but I can move it to this one? |
|
@jbouder I just modified the script to make sure it regenerates dist when you run the dev server so that its never stale, so should be good now |
smeragoel
left a comment
There was a problem hiding this comment.
Hi @mikemazara, thanks for working on this, looks neat! A few things:
- Left navbar items:
- The hover state should have an underline on the text and a left border. Having these indicators essentally removes the contrast requirement for the background since we have non-colour indicators for hover.
- Focus rings should be the Nebari brand purple rather than black.
- Breadcrumbs: the parent pages don't render as links and aren't clickable. The active page should use primary font color and parent pages are muted.
- The table breaks long components at narrow widths (
Overridden). I am curious what'd happen to long strings / literals / paths that ideally should not be broken.
- Is
Copy As Markdownin scope for this PR or the next one? - This would be a design fix but I personally don't like how light the code literals are, both in weight and color. What do others think?
|
@smeragoel: |
|
@smeragoel Updated! |
smeragoel
left a comment
There was a problem hiding this comment.
Thanks for the changes @mikemazara, looking good! I am previewing both this PR and PR #29 together. I will try to separate the feedback, but there might be some overlaps!
-
Hover interactions: A lot of components are missing hover interactions, mainly underline. I'm assuming that most (if not all) of them are being pulled from NDS, so not sure why we have this issue. For example,
- The homepage buttons
Get Started,Read the Guides, don't have underline or bg color change on hover. - Links (
Install the themeetc.) are missing an underline on hover. - For the popular pages row, it is a custom card so it doesn't have an NDS basis, but it will be nice to have hover interactions on it as well. Added the design here.
- The homepage buttons
-
Footer:
-
Code literals: I designed updated code literals.
-
There are some fill clipping and border issues with the code preview.

-
The on-this-page sidebar is missing the hover interactions you added to the left sidebar.
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
|
@smeragoel another round! |
There was a problem hiding this comment.
-
Row card (Figma):
-
Card links don't have underline on hover.
Also, I like how the new code literals are looking!











Reference Issues or PRs
PR 1 of 2
partial implementation of #25
#9547c0accent,sm/md/fullradii, Geist + IBM Plex Mono self-hosted (12 woff2 → 2, no external requests), full type scale, Expressive Code syntax colours.#f8f8f8header at 56px with one hairline, nav tabs with a 2px accent underline, search as a borderedmdinput withSearch docs…and a ⌘K chip, sidebar accent bar + fill, TOC eyebrow + accent bar + hairline, 375px drawer.Updated <date> • N min readmeta row, hairline under the title block, prev/next cards.Chrome CSS is split into a new
chrome.cssso a Starlight upgrade has one file to review. Adds one option,nav; unset, header markup is unchanged, so existing packs upgrade without visual change.Not included: callouts, tables, code-frame variants (Phase 4); hero, guides landing, 404, ⌘K modal (Phase 5); docs, screenshots, version bump (Phase 6). Ask AI and the version selector are out of scope.
Was this page helpful?is deferred — no behaviour is specified for it.What does this implement/fix?
Put a
xin the boxes that applyTesting
Documentation
Access-centered content checklist
Text styling
H1or#in markdown).Non-text content
Any other comments?
Accessibility notes, since this changes presentation site-wide:
nav; the page title keepsid="_top"for the skip link; exactly one nav tab isaria-current="page"and one "Site" landmark is exposed at any width.injectTranslations, so it changes the real accessible name rather than being faked in CSS.