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

Mintlify Updated #2049

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

Conversation

Bipul70701
Copy link

"Converted documentation to MDX format for Mintlify. Updated structure and formatting to align with Mintlify requirements, ensuring proper syntax highlighting and modular organization. Ready for merging into the repo."

Let me know if you'd like any refinements!

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@1sarthakbhardwaj
Copy link
Collaborator

Thanks @Bipul70701!

docs.json Outdated
{
"$schema": "https://mintlify.com/schema.json",
"name": "CAMEL Documentation",
"theme": "mint",
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you help to align the theme with our branding, specifically color from mint to #B5AFFF

@zjrwtx
Copy link
Collaborator

zjrwtx commented Mar 31, 2025

thanks @Bipul70701 ,is this related to this issue?#798

@zjrwtx
Copy link
Collaborator

zjrwtx commented Mar 31, 2025

hello @Bipul70701 ,Cause this pr changed too many files,Whether the benefits of this ultimate goal effect are worth it?

@1sarthakbhardwaj
Copy link
Collaborator

thanks @Bipul70701 ,is this related to this issue?#798

Yes, this is related to issue no #798

@1sarthakbhardwaj
Copy link
Collaborator

hello @Bipul70701 ,Cause this pr changed too many files,Whether the benefits of this ultimate goal effect are worth it?

Hi @zjrwtx , this PR is related to the ongoing effort of converting the documentation from Sphinx to Mintlify for improved readability and maintainability.

@Bipul70701, could you please share the deployed Mintlify documentation link of your repo for reference? That would help in evaluating the impact more effectively.

@zjrwtx
Copy link
Collaborator

zjrwtx commented Apr 1, 2025

thanks @Bipul70701 ,is this related to this issue?#798

Yes, this is related to issue no #798

ok, i see

@zjrwtx
Copy link
Collaborator

zjrwtx commented Apr 1, 2025

if we change to mdx,what if user download cookbook to local and wanna run directly?

@1sarthakbhardwaj
Copy link
Collaborator

1sarthakbhardwaj commented Apr 1, 2025

if we change to mdx,what if user download cookbook to local and wanna run directly?

Screenshot 2025-04-01 at 11 06 42 AM

As Mintlify doesn't support the .ipynb format so we had to change it to mdx. For user they can access it via the colab link which is mentioned on the top of every cookbook

@1sarthakbhardwaj
Copy link
Collaborator

@Bipul70701 Can you also help with updating this https://github.com/camel-ai/camel/blob/master/CONTRIBUTING.md#documentation- accordingly.

@Bipul70701
Copy link
Author

Sure @1sarthakbhardwaj on it

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.

3 participants