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

feat: Migrate docs #646

Merged
merged 12 commits into from
Dec 19, 2023
Merged

feat: Migrate docs #646

merged 12 commits into from
Dec 19, 2023

Conversation

cpacker
Copy link
Collaborator

@cpacker cpacker commented Dec 19, 2023

Migrating docs to readme.

Visible here: https://memgpt.readme.io/docs

Build process:

  • Use the rdme CLI tool to sync docs from markdown to readme.com (one-way only, do NOT edit on readme.com without editing the source files, or the next sync will globber your GUI edits)
    • Install w/ npm install -g rdme (from here)
    • inside memgpt home directory, do rdme docs docs (format is rdme <type> <folder>)
  • This is automated via the added github action

Review comments:

  • Deprecate old docs? (should we maintain readthedocs domain and use redirects?)
  • Figure out how to add GitHub link to readme.com
    • Current mkdocs has a cool viewer where it shows the current starts + links to GitHub
  • Figure out what to do about editing
    • Previously on readthedocs you could click "edit" on the docs page and it would bring you to the github file editor
    • On readme.com, it will bring you to a login page, where a user can login to readme.com then propose an edit using their WYSIWYG markdown editor, which will open a "proposed change" ticket inside of the readme.com developer panel
    • One solution: disable propose edits button on readme.com, and explain how to edit on our contributor guide
    • Another solution: try and figure out a way to dynamically insert github raw file edit link into readme.com html (or manually do it?)
    • Third solution: just leave it, and manually handle edits that people submit in the markdown GUI editor (if any)

- [ ] Add API reference section to docs

  • Big change, should put in later PR

@cpacker cpacker changed the title Migrate docs feat: Migrate docs Dec 19, 2023
@cpacker cpacker requested a review from sarahwooders December 19, 2023 02:24
Copy link
Collaborator

@sarahwooders sarahwooders left a comment

Choose a reason for hiding this comment

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

lgtm!

@cpacker cpacker merged commit c029008 into main Dec 19, 2023
5 checks passed
@cpacker cpacker deleted the migrate-docs branch December 22, 2023 18:35
sarahwooders pushed a commit that referenced this pull request Dec 26, 2023
* updated docs for readme

* Update index.md

* Update index.md

* added header

* broken link

* sync heading sizes

* fix various broken rel links

* Update index.md

* added webp

* Update index.md

* strip mkdocs/rtk files

* replaced readthedocs references with readme
norton120 pushed a commit to norton120/MemGPT that referenced this pull request Feb 15, 2024
* updated docs for readme

* Update index.md

* Update index.md

* added header

* broken link

* sync heading sizes

* fix various broken rel links

* Update index.md

* added webp

* Update index.md

* strip mkdocs/rtk files

* replaced readthedocs references with readme
mattzh72 pushed a commit that referenced this pull request Oct 9, 2024
* updated docs for readme

* Update index.md

* Update index.md

* added header

* broken link

* sync heading sizes

* fix various broken rel links

* Update index.md

* added webp

* Update index.md

* strip mkdocs/rtk files

* replaced readthedocs references with readme
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.

2 participants