feat: migrate documentation to mintlify
Which issue(s) does this pull-request address?
Closes: #675
Description
this PR migrates the current documentation to Mintlify
-
.mdfiles converted to.mdxupdating syntax where necessary - links reviewed & updated
- Python and TypeScript documentation combined
- Python and TypeScript code blocks moved into a tabbed code preview container
- update
poe docsscript accordingly
Checklist
General
- [ ] I have read the appropriate contributor guide: Python / TypeScript
- [ ] I have signed off on my commit: Python instructions / TypeScript instructions
- [ ] Commit messages and PR title follow conventional commits
- [ ] Appropriate label(s) added to PR:
Pythonfor Python changes,TypeScriptfor TypeScript changes
Code quality checks
- [ ] Linting passes: Python
poe lintorpoe lint --fix/ TypeScriptyarn lintoryarn lint:fix - [ ] Formatting is applied: Python
poe formatorpoe format --fix/ TypeScript:yarn formatoryarn format:fix - [ ] Static type checks pass: Python
poe type-check
Testing
- [ ] Unit tests pass: Python
poe test --type unit/ TypeScriptyarn test:unit - [ ] E2E tests pass: Python
poe test --type e2e/ TypeScript:yarn test:e2e - [ ] Integration tests pass: Python
poe test --type integration - [ ] Tests are included (for bug fixes or new features)
Documentation
- [ ] Documentation is updated
- [ ] Embedme embeds code examples in docs. To update after edits, run: Python
poe docs --type build
#739 #740 #741 #742 are ready to merge into this docs/mintlify branch (before this is merged to main)
We could merge this branch (I created a branch off it & rebased cleanly, it also has no broken links). However until this replaces the existing docs there's a risk of content divergence.
I fixed the UI and script embedding.
I merged changes from @markstur. Updated the integration guide, some links, and added the embedding section.
I merged changes from @markstur. Updated the integration guide, some links, and added the embedding section.
Looks great! Let's get this on main so we can maintain it with smaller updates.
Weeee! Nice job team 👏
🎉 Thanks, Tomas! So good to have this on main instead of a branch