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

missing mkdocs.yml file "feat: Migrate docs #646 " #662

Closed
3 tasks
r3d91ll opened this issue Dec 20, 2023 · 2 comments
Closed
3 tasks

missing mkdocs.yml file "feat: Migrate docs #646 " #662

r3d91ll opened this issue Dec 20, 2023 · 2 comments

Comments

@r3d91ll
Copy link

r3d91ll commented Dec 20, 2023

Describe the bug
It appears that the mkdocs.yml file was deleted during " feat: Migrate docs #646 ", The mkdocs now builds but does so incorrectly. see attached screenshot

Please describe your setup

  • MemGPT version
    I noticed when I cloned a new dev instance
  • How did you install memgpt?
    • Cloned and followed the steps as outlined in docs/contributing_code.md
  • Describe your setup
    • Ubuntu 2004 workstation, running through VS Studio code terminal.
      Screenshot at 2023-12-20 13-02-32

Screenshots
If applicable, add screenshots to help explain your problem.

Additional context
Add any other context about the problem here.


@cpacker
Copy link
Collaborator

cpacker commented Dec 20, 2023

Hi @r3d91ll - we actually migrated off of mkdocs+readthedocs to readme, and in doing so deprecated support for the mkdocs workflow (otherwise we'd have to start maintaining both the mkdocs index and the readme index). If you need a copy of the docs pre-migration you can check the docs-checkpoint branch.

AFAIK there's no easy way to build readme docs into a site locally which is an unfortunate downside of this migration (I think the "correct" way to do this is to set up your own readme project and use rdme docs to sync to your own site for viewing?). Closing for now since this deprecation is intended, but if you have any feedback on a good way to support local builds to html that doesn't require maintaining another index like w/ mkdocs happy to try and incorporate it.

@cpacker cpacker closed this as not planned Won't fix, can't repro, duplicate, stale Dec 20, 2023
@r3d91ll
Copy link
Author

r3d91ll commented Dec 31, 2023

No worries. I was unaware of the migration. Thank you for the explanation Ill checkout the docs-checkpoint

mattzh72 pushed a commit that referenced this issue Jan 16, 2025
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

No branches or pull requests

2 participants