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

Refactor: Align AI metadata components with Docusaurus theme conventions #27

Closed
wants to merge 1 commit into from

Conversation

amiable-dev
Copy link
Owner

This PR refactors the AI metadata components to better align with Docusaurus theme conventions.

Key Changes:

  1. Reorganized component structure:

    src/theme/
      BlogPost/
        Header/
          AIMetadata/
            index.tsx
            types.ts
    
  2. Updated component names and locations:

    • Moved from components/ to theme/
    • Integrated with BlogPost/Header
    • Added proper TypeScript types
  3. Added comprehensive documentation:

    • Component structure guide
    • Naming conventions
    • Integration instructions
    • Migration guide

Benefits:

  • Better alignment with Docusaurus conventions
  • More granular swizzling options
  • Clearer component organization
  • Better scalability for future AI features
  • Improved TypeScript support

Testing:

  • Verify component rendering
  • Test swizzling process
  • Check dark/light mode
  • Validate TypeScript types
  • Test import paths

Migration Notes:
Users will need to:

  1. Update import paths
  2. Re-swizzle components if needed
  3. Update any custom styling

Closes #26

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.

Refactor AI metadata component structure for Docusaurus conventions
1 participant