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

Move to Mintlify #14

Merged
merged 9 commits into from
Nov 18, 2024
Merged

Move to Mintlify #14

merged 9 commits into from
Nov 18, 2024

Conversation

psykhi
Copy link
Member

@psykhi psykhi commented Nov 18, 2024

Important

Transition documentation from MkDocs to Mintlify, reorganizing content and updating files to .mdx format with new Mintlify configuration.

  • Documentation Platform:
    • Transition from MkDocs to Mintlify, removing mkdocs.yml, pyproject.toml, and Makefile.
    • Add mint.json for Mintlify configuration.
  • Content Restructuring:
    • Reorganize documentation into new directories: features, integrations, tips-tricks, user-guides.
    • Convert .md files to .mdx format for compatibility with Mintlify.
  • Content Updates:
    • Update README.md to reflect Mintlify usage.
    • Add new sections and update existing ones, such as features/deploy.mdx, integrations/git-integration.mdx, and tips-tricks/using-images.mdx.
    • Remove CONTRIBUTING.md as part of the transition.
  • Assets and Media:
    • Rename and relocate media files from src/assets to assets.
    • Update references to images and videos in documentation files.

This description was created by Ellipsis for da785e4. It will automatically update as commits are pushed.

Copy link

netlify bot commented Nov 18, 2024

Deploy Preview for gpt-engineer-docs failed. Why did it fail? →

Name Link
🔨 Latest commit da785e4
🔍 Latest deploy log https://app.netlify.com/sites/gpt-engineer-docs/deploys/673b4898aa12f00008a87f0a

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

❌ Changes requested. Reviewed everything up to ed0c692 in 1 minute and 8 seconds

More details
  • Looked at 1918 lines of code in 39 files
  • Skipped 21 files when reviewing.
  • Skipped posting 0 drafted comments based on config settings.

Workflow ID: wflow_HhoA0f05hUk8IWzy


Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

tips-tricks/custom-domain.mdx Outdated Show resolved Hide resolved
psykhi and others added 2 commits November 18, 2024 14:26
Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com>
Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

👍 Looks good to me! Incremental review on 5f86986 in 16 seconds

More details
  • Looked at 40 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. features/deploy.mdx:6
  • Draft comment:
    Unnecessary HTML entity &#x20; for space. Consider removing it for better readability.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The use of HTML entities like &#x20; for spaces is unnecessary and can be removed for better readability.

Workflow ID: wflow_cUfSAMOYwJMHg17t


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

👍 Looks good to me! Incremental review on da785e4 in 17 seconds

More details
  • Looked at 48 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 0 drafted comments based on config settings.

Workflow ID: wflow_fZub6RAptdLRuu9t


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

@psykhi psykhi merged commit 1c59f95 into main Nov 18, 2024
1 of 5 checks passed
@psykhi psykhi deleted the mintlify branch November 18, 2024 14:10
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