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

Migrating FD Knowledge Base #222

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Migrating FD Knowledge Base #222

wants to merge 1 commit into from

Conversation

Wyle09
Copy link
Contributor

@Wyle09 Wyle09 commented Feb 25, 2025

Migrate Freshdesk Knowledge Base to MDX Documentation

Overview

This PR migrates our existing Freshdesk knowledge base content into our markdown documentation. As a first step, all FAQs have been consolidated into a single page under the product section since many questions span multiple platforms.

Key Changes

  1. Created a Python script to:

    • Convert HTML/Freshdesk formatting to MDX-compatible markdown
    • Handle special characters and angle brackets properly
    • Format code blocks consistently
    • Remove references to Freshdesk-hosted images and content
    • Clean up formatting inconsistencies
  2. Added comprehensive FAQ content covering:

    • Android-specific questions
    • iOS-specific questions
    • React Native questions
    • General platform questions
  3. Implemented formatting improvements:

    • Proper escaping of angle brackets and special characters
    • Consistent code block formatting with language indicators
    • Clean handling of inline code tags
    • Removal of Freshdesk-specific content and URLs

Technical Details

  • All FAQs are currently in /docs/product/faq.md
  • Content is MDX-compatible and builds without compilation errors
  • Removed dependencies on Freshdesk-hosted resources
  • Preserved all valuable content while removing obsolete references

Future Work

While this PR successfully migrates the content, some follow-up work should be considered:

  1. Split the large FAQ file into platform-specific files
  2. Reorganize content into more specific categories
  3. Update and verify all external links
  4. Add additional metadata and tags for better organization
  5. Review and update content for accuracy and completeness

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