Skip to content

docs: add <StarlightPage> import order guidelines #3199

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

HiDeoo
Copy link
Member

@HiDeoo HiDeoo commented May 13, 2025

Description

This PR updates the <StarlightPage> component documentation to help with issue 2 in #3162:

After trying many possible workarounds to find a way around what seems to be an unsolvable issue, which depends on how import order works in Astro and also many variables e.g. the number of routes, etc., this PR adds guidelines to the documentation regarding the import order of the <StarlightPage> component and its role in setting up cascade layers.

This first attempt is based on recommendations from Sarah during a Talking & Doc'ing session mentioning the limitations using text and code example comments.

I tried to avoid an aside even tho we use one in the Astro Docs:

image

Considering how tricky this is, maybe it should be an aside but I wanted to try a first approach without it. Open to any suggestions.

Copy link

changeset-bot bot commented May 13, 2025

⚠️ No Changeset found

Latest commit: 1d35a18

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

netlify bot commented May 13, 2025

Deploy Preview for astro-starlight ready!

Name Link
🔨 Latest commit 1d35a18
🔍 Latest deploy log https://app.netlify.com/sites/astro-starlight/deploys/68230970b6df6900086c6c58
😎 Deploy Preview https://deploy-preview-3199--astro-starlight.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 100 (no change from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 100 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@github-actions github-actions bot added the 📚 docs Documentation website changes label May 13, 2025
@astrobot-houston
Copy link
Collaborator

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

Locale File Note
en guides/pages.mdx Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 docs Documentation website changes
2 participants