-
Notifications
You must be signed in to change notification settings - Fork 23
docs: migrate guides from v1 to v2 Starlight #182
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
base: main
Are you sure you want to change the base?
docs: migrate guides from v1 to v2 Starlight #182
Conversation
|
@mohith2883 is attempting to deploy a commit to the Cloudinary DevX Team on Vercel. A member of the Team first needs to authorize it. |
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.
hey! Thanks for the PR @mohith2883, apologies for the late review 🙏 I added some comments which apply to all the guides here. They need slight tweaks to work with our v2 docs.
You can view instructions in our CONTRIBUTING.md to see how to run the docs locally - don't forget to run pnpm format
!
Let me know if you have any issues
Hey @ghostdevv can you have a look |
Hey @eportis-cloudinary can you check it |
Hey @ghostdevv can you check it |
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.
Hey, thanks for your patience and work here! I was away most of last week so wasn't able to review. I've left a few more comments I've seen, most of the changes are in all of the files so if you could check them that would be awesome. When that's done I think we can get this merged!
<Callout emoji={false}> | ||
Removing backgrounds require enabling the <a href="https://cloudinary.com/documentation/cloudinary_ai_background_removal_addon">Cloudinary AI Background Removal Add-On</a> which includes a free tier for getting started. | ||
</Callout> |
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.
These callouts need migrating to the markdown syntax in each of the pages. For example, this one would be done like this:
<Callout emoji={false}> | |
Removing backgrounds require enabling the <a href="https://cloudinary.com/documentation/cloudinary_ai_background_removal_addon">Cloudinary AI Background Removal Add-On</a> which includes a free tier for getting started. | |
</Callout> | |
:::note | |
Removing backgrounds require enabling the [Cloudinary AI Background Removal Add-On](https://cloudinary.com/documentation/cloudinary_ai_background_removal_addon) which includes a free tier for getting started. | |
::: |
<script> | ||
|
||
import Callout from '$lib/components/Callout.svelte' | ||
import Video from '$lib/components/Video.svelte' | ||
import { Tabs, Tab} from '$lib/components/Tabs' | ||
import { CldOgImage, CldImage } from 'svelte-cloudinary' | ||
|
||
</script> |
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.
There are some more unused imports/script tags that exist in most of the files, here is one example of the change needed:
<script> | |
import Callout from '$lib/components/Callout.svelte' | |
import Video from '$lib/components/Video.svelte' | |
import { Tabs, Tab} from '$lib/components/Tabs' | |
import { CldOgImage, CldImage } from 'svelte-cloudinary' | |
</script> | |
import { CldImage } from 'svelte-cloudinary' |
```html | ||
<script> | ||
|
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.
Ah my bad, the import in the examples shouldn't have been removed! The codeblocks that use svelte code should also be annotated as such (i.e. not html
)
Description
Migrated the guides from v1 docs to v2 Starlight docs.
Added the following guides under
packages/docs/src/content/guides
in.mdx
format:• Background Removal
• Image Optimization
• Image Overlays
• Image Underlays
• Placeholders
• Responsive Images
• Social Media Cards
• Text Overlays
• Uploading Images and Videos
Updated content to match Starlight syntax (
.mdx
, Tabs component, Callouts, etc.)Removed outdated redirect entries for guides from
vercel.json
.Issue Ticket Number
Fixes #122
Type of change
Checklist