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

Migrated docs form Mintlify to MkDocs #122

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

RamGoel
Copy link

@RamGoel RamGoel commented Feb 20, 2025

Related Issue
Fixes #76

Description of Changes
I've moved all the documentation of preswald from preswald-docs to this repo. This also changes the docs provider from Mintlify to MkDocs, and after successfully merging this PR, the original docs repo can be removed.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • New example
  • Test improvement

Testing
Please describe the tests that you ran to verify your changes. Include screenshots/videos.

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have run my code against examples and ensured no errors
  • Any dependent changes have been merged and published in downstream modules

@RamGoel
Copy link
Author

RamGoel commented Feb 20, 2025

Steps to be performed

  • Moved all docs
  • Built most of the layout
  • Fixing up the images/graphs/cards broken due to provider change
  • Adding community/blog etc links with icons
  • setting up a way to build this

@RamGoel
Copy link
Author

RamGoel commented Feb 21, 2025

@shivam-singhal when you come back, can you please give me some information about deployment of preswald. So I can research about how the blogs will be built along with the app

can you help with this @jayanth-kumar-morem

@RamGoel RamGoel marked this pull request as ready for review February 25, 2025 12:24
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.

[FEATURE] Use MKDocs for documentation
1 participant