Add more EC text markers and frames to Starlight docs#1102
Add more EC text markers and frames to Starlight docs#1102delucis merged 7 commits intowithastro:mainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Co-authored-by: Hippo <6137925+hippotastic@users.noreply.github.com>
kevinzunigacuellar
left a comment
There was a problem hiding this comment.
Love the Expressive codification of Starlight 💜
There was a problem hiding this comment.
Curious what other people think here. A lot of these code snippets are fragments like
starlight({
customCss: ['./src/custom-styles.css', '@fontsource/roboto'],
})In these cases, I wonder if it’s misleading to add the astro.config.mjs file name because it makes it looks like this is the full file rather than just a part of it?
There was a problem hiding this comment.
I think this makes sense and we could definitely remove the frame titles (except the first one).
Altho, if we go with this approach, we have the same pattern in the following files that may need fixing too:
docs/src/content/docs/guides/customization.mdxdocs/src/content/docs/guides/sidebar.mdx
The question would be if we either remove the frame titles for those too or we add the imports? Or maybe this is only relevant in this specific file?
There was a problem hiding this comment.
Scrolling through customization.mdx on the current production version I think that actually looks good yeah — file names are used for full examples, and not for shorter fragments (usually accompanying a longer one like in the “Add your logo” section).
There was a problem hiding this comment.
I personally like the startlight() snippets because they are easier to copy and paste. Sometimes I would have a very convoluted astro.config and just having the startlight snippet to copy and paste is very nice.
Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
Co-authored-by: Kevin Zuniga Cuellar <46791833+kevinzunigacuellar@users.noreply.github.com>
|
Updated the PR with the suggested changes and left a comment regarding the |
|
Updated the PR with the following changes:
I think this should cover all the feedback we got so far. Let me know if I missed anything or if you have any other suggestions. |
* `overriding-components.md` #1168 * `getting-started.mdx` (#1241) * `components.mdx` (#1102) * `css-and-tailwind.mdx` (#1102) * `customization.mdx` (#1102) * `manual-setup.mdx` (#1102) * translate filename in `components.mdx` * fix: indentation Co-authored-by: Chris Swithinbank <swithinbank@gmail.com> --------- Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
What kind of changes does this PR include?
Description
This PR is a follow-up to this comment I made in the EC PR and a review I did a while ago regarding all the code blocks in the Starlight documentation to add missing EC text markers and frame informations in a more consistent way.
I edited everything I could find but I think some may be up to discussions, like for example having
src/content/docs/example.mdas frame title for all examples in the frontmatter reference may not be the best, but as I don't personally know the guidelines for this I think this PR could be used as a base to discuss this even if we end up not merging it or only partially (we could also decide to add this kind of changes only when we next edit the relevant portions of the docs).