Skip to content

Conversation

mohith2883
Copy link

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

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Fix or improve the documentation
  • This change requires a documentation update

Checklist

  • I have followed the contributing guidelines of this project as mentioned in CONTRIBUTING.md
  • I have created an issue ticket for this PR
  • I have checked to ensure there aren't other open Pull Requests for the same update/change?
  • I have performed a self-review of my own code
  • I have run tests locally to ensure they all pass
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes needed to the documentation

Copy link

changeset-bot bot commented Oct 1, 2025

⚠️ No Changeset found

Latest commit: da2eb3f

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

vercel bot commented Oct 1, 2025

@mohith2883 is attempting to deploy a commit to the Cloudinary DevX Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Collaborator

@ghostdevv ghostdevv left a 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

@mohith2883
Copy link
Author

Hey @ghostdevv can you have a look

@mohith2883
Copy link
Author

Hey @eportis-cloudinary can you check it

@mohith2883
Copy link
Author

Hey @ghostdevv can you check it

Copy link
Collaborator

@ghostdevv ghostdevv left a 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!

Comment on lines +11 to +13
<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>
Copy link
Collaborator

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:

Suggested change
<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.
:::

Comment on lines +5 to +12
<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>
Copy link
Collaborator

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:

Suggested change
<script>
import Callout from '$lib/components/Callout.svelte'
import Video from '$lib/components/Video.svelte'
import { Tabs, Tab} from '$lib/components/Tabs'
importCldOgImage, CldImage } from 'svelte-cloudinary'
</script>
importCldImage } from 'svelte-cloudinary'

Comment on lines +41 to +43
```html
<script>

Copy link
Collaborator

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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

re-add old guides to the new docs

3 participants