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

Migrate Documentation from GitBook to Docusaurus #217

Draft
wants to merge 1 commit into
base: v6
Choose a base branch
from

Conversation

faresh9
Copy link

@faresh9 faresh9 commented Jan 7, 2025

This PR migrates the documentation from GitBook to Docusaurus. The following changes have been made:

  • Updated Markdown Files: All Markdown files have been updated to follow the Docusaurus format.
  • Updated Sidebar Configuration: The sidebars.ts file has been configured to include all necessary documentation sections.
  • Updated Configuration Files: The docusaurus.config.ts file has been updated with the correct project settings.
  • Ran Update Script: The update-md-files.js script has been run to replace custom syntax and update links.
  • Verified Documentation Structure: The documentation structure in the docs folder has been updated to follow the Docusaurus format.

Remaining Tasks:

  • Verify Links: Ensure all internal and external links are working correctly.
  • Update Images: Ensure all images are correctly referenced and displayed.
  • Test Locally: Run the Docusaurus site locally to ensure everything is working as expected.
  • Review Content: Review the content for any inconsistencies or formatting issues.
  • Update Edit URLs: Ensure the docusaurus.config.ts file is setup correctly.
  • Reorder/edit sidebar categories.
  • CSS styles: redesign the website, and import styles.

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