-
Notifications
You must be signed in to change notification settings - Fork 639
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
v2 migration: guides/development
to next
#1670
Conversation
✅ Deploy Preview for tauri-docs-starlight ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you! @vasfvitor ! A few notes:
- KO and IT translations: I saw your message on Discord this morning (just getting back in). I think we should transfer those translations into this branch as well but keep them deactivated. I haven't looked into the best way to do this (whether via drafts, using an underscore prefix, etc.) but I saw you had a local draft with that so will take your guidance on that
- Instead of having all of the sub-pages in the sidebar I'd prefer to just keep the "parent" page, so in this case "Develop". Then on that landing page you could use the
LinkCard
component to jump out to those. One UX item I don't like with that is the parent's sidebar entry won't be highlighted when on a sub-page. I've put in a discussion for this in Highlight Sidebar Entry for Subpages withastro/starlight#950 and I know that Astro's main docs are also wanting similar behaviour. We can always do a component override to get this functionality in the meantime.
Co-authored-by: Lorenzo Lewis <[email protected]>
Co-authored-by: Lorenzo Lewis <[email protected]>
Co-authored-by: Lorenzo Lewis <[email protected]>
About the translations: Ok, I'll look what I've done here About the highlight: I've been following the Astro Docs migration to Starlight and they at least solved this in their code as you can see here https://docs-git-fork-theotterlord-starlight-migration-astrodotbuild.vercel.app/en/tutorial/1-setup/ |
Awesome! And yes, I heard Sarah say at one point that Astro docs wanted that sub-item highlighting, but didn't take the time to see if/how they'd implemented it. So awesome to see! I prefer option 1 with the grid with descriptions. One approach you could use to reduce duplicating those descriptions would be to pull in the content collection entry and get the respective title and description (if available) from there. I've done a similar thing in this component: https://github.com/tauri-apps/tauri-docs/blob/next/src/components/list/Features.astro (note: I haven't tested if it works correctly for i18n'd pages, I'm 99% sure it does not). I actually have been wanting to build on top of Would you be interested in wrapping |
As of now, all pages shares the same description from v1 docs. The ones in the image was copied from page contents as an example. And from what I've seen in v1 pages, it's the same deal: shared description from the Just to be sure we'll settle with 1, then fallback to 2? Will we write copy for each page? I'm not sure I follow you on the "PR that upstream" part. I understood: create a custom component and open a separated PR here for it to be available. To update, I'm already playing with a new/replacement component (based on Aiming to make available translated content and fallback in the list, and if I manage, add a "fallback" notice on the card. So far it kinda works for both i18n translated and default pages, but not for fallback, yet. Almost there |
guides/development
to nextguides/development
to next
Sorry, I could have been a little more clear in my explanation, so my bad. Let's go with how you currently have it setup for this PR (with just the title and link) and then we can work through #1717 in parallel then update once that's done (if needed). I'll put a few more comments on that PR directly for that. Does that all sound alright? Ready to merge this in? |
`index.md` was `develop.md`. Page title was present in v1 docs.
updated to be list, for now without description. |
Perfection! Thank you very much! Hopefully the other will be a bit easier now to push through. |
guides/development
to nextguides/development
to next
What kind of changes does this PR include?
Description
Pages:
https://tauri.app/v1/guides/development/development-cycle
https://tauri.app/v1/guides/development/updating-dependencies
v2 (next):
Original from v1:
sidebar preview:
Personal Notes (can be ignored)
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
can be replaced by
import { Tabs, TabItem } from '@astrojs/starlight/components';
to place code, if neededor
import CommandTabs from '@components/CommandTabs.astro';
to place commandsThis
import Command from '@theme/Command'
to
import CommandTabs from '@components/CommandTabs.astro';
The Command
<Command name="dev" />
becomes
https://starlight.astro.build/guides/authoring-content/#note-aside
:::info title
into
:::caution[title]
:::info
can be:note
,tip
,caution
ordanger
depending on context.