Skip to content
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

Small documentation update #87

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Conversation

jlewin
Copy link

@jlewin jlewin commented Jan 11, 2025

No description provided.

@@ -24,7 +24,7 @@ require('dotenv').config();
docs: {
sidebarPath: require.resolve('./sidebars.js'),
// Please change this to your repo.
editUrl: 'https://github.com/facebook/docusaurus/edit/main/website/',
editUrl: 'https://github.com/advanced-cropper/react-advanced-cropper/tree/master/example/',
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not yet able to test and verify this fixes the Edit this page link but it seems correct and works if a simple replace operation is performed on the redirect url, using the old and new editUrl values

@@ -1,5 +1,5 @@
---
title: CropperBackgroundImage
title: TransformableImage
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There were previously three CropperBackgroundImage components in the tree. These title changes correct the confusing duplication

@@ -5,6 +5,8 @@ sidebar_position: 3

import TOCInline from "@theme/TOCInline";

Used to display the current cropped area and change it by interaction with it.
Copy link
Author

@jlewin jlewin Jan 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Simple high level details when landing on the components pages might help new users with the learning curve. Details sourced from existing content in components-and-hooks.mdx

@jlewin jlewin changed the title Mild documentation updates Small documentation update Jan 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant