docs: add <StarlightPage>
import order guidelines
#3199
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
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.