Skip to content

Update starlight docs 2 - #29

Merged
mikemazara merged 35 commits into
mainfrom
update-starlight-docs-2
Sep 1, 2026
Merged

Update starlight docs 2#29
mikemazara merged 35 commits into
mainfrom
update-starlight-docs-2

Conversation

@mikemazara

@mikemazara mikemazara commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Guides, 404, Modal, and docs

Reference Issues or PRs

What does this implement/fix?

Put a x in the boxes that apply

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds a feature)
  • Breaking change (fix or feature that would cause existing features not to work as expected)
  • Documentation Update
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Build related changes
  • Other (please describe):

Testing

  • Did you test the pull request locally?
  • Did you add new tests?

Documentation

Access-centered content checklist

Text styling

  • The content is written with plain language (where relevant).
  • If there are headers, they use the proper header tags (with only one level-one header: H1 or # in markdown).
  • All links describe where they link to (for example, check the Nebari website).
  • This content adheres to the Nebari style guides.

Non-text content

  • All content is represented as text (for example, images need alt text, and videos need captions or descriptive transcripts).
  • If there are emojis, there are not more than three in a row.
  • Don't use flashing GIFs or videos.
  • If the content were to be read as plain text, it still makes sense, and no information is missing.

Any other comments?

@mikemazara
mikemazara requested a review from smeragoel August 20, 2026 23:01
@mikemazara
mikemazara marked this pull request as draft August 20, 2026 23:01
@mikemazara
mikemazara marked this pull request as ready for review August 20, 2026 23:01
@mikemazara
mikemazara requested a review from jbouder August 20, 2026 23:01
@smeragoel smeragoel mentioned this pull request Aug 24, 2026
18 tasks

@smeragoel smeragoel left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the changes @mikemazara, looking good! I am previewing both this PR and PR #27 together. I will try to separate the feedback, but there might be some overlaps!

Guides:

  1. The All, Getting Started, etc. pills are supposed to be quick filters for all the guides on the page. Currently, they link to a specific page within that category.
  2. We can add hover interaction to the guide cards as well, added here.

404 page:

  1. The page opens on vertical scroll by default. We can resize the 404 gradient box itself so that the page doesn't need to scroll.
  2. Not sure if the content is final, but the home and guide text is repeating what the buttons are doing.
  3. There's a leftover section at the bottom that shouldn't be there.
Image

@mikemazara
mikemazara requested a review from smeragoel August 25, 2026 06:05
@mikemazara

Copy link
Copy Markdown
Contributor Author

@smeragoel updated, let me know if i missed anything

@smeragoel smeragoel left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Guides
    1. Focus should be on the entire clickable area. Image
    2. Not sure if this is in scope, but the read time on the guide cards (5 mins) doesn't match the read time on the article (1 min).
    3. The process / step component shouldn't have the vertical line on the last bullet (3) Image

@mikemazara
mikemazara requested a review from smeragoel August 25, 2026 15:23
@mikemazara

Copy link
Copy Markdown
Contributor Author

@smeragoel updated from the previous pr and this ones lates comments here!

# Conflicts:
#	packages/starlight/src/components/SiteTitle.astro
#	packages/starlight/src/index.ts
#	packages/starlight/src/virtual.d.ts

@smeragoel smeragoel left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding the requested changes, lgtm!

@jbouder jbouder left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor thing

Comment thread .cursor/settings.json Outdated
mikemazara and others added 3 commits September 1, 2026 06:58
Local editor config that was committed unintentionally (PR #29 review).
The file stays on disk; .gitignore keeps it out of source from now on.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Base automatically changed from update-starlight-docs to main September 1, 2026 14:03
# Conflicts:
#	docs/astro.config.mjs
#	docs/e2e/theme-search-a11y.spec.ts
#	docs/src/content/docs/index.mdx
#	packages/starlight/src/components/MarkdownContent.astro
#	packages/starlight/src/index.ts
#	packages/starlight/src/styles/chrome.css
#	packages/starlight/src/styles/components.css
#	packages/starlight/src/styles/theme.css
#	packages/starlight/test/build.test.ts

@jbouder jbouder left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

@mikemazara
mikemazara merged commit b869c97 into main Sep 1, 2026
2 checks passed
@mikemazara
mikemazara deleted the update-starlight-docs-2 branch September 1, 2026 14:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants