Skip to content

[Feat]: Deploy Mintlify documentation preview for each PR #1073

@SarahScargall

Description

@SarahScargall

Is your feature request related to a problem?

Currently, users cannot preview the most recent version of Mintlify-generated documentation for the project until after changes are merged. This limits visibility and feedback for updates and improvements, especially for larger or frequently updated pull requests.

Describe the solution you'd like

Deploy Mintlify-generated documentation to the project's GitHub Pages URL automatically for each pull request. This would allow users and reviewers to access and view the latest documentation changes before they are merged, using a live preview for each PR.

Describe alternatives you've considered

Alternative solutions include manually building and uploading docs artifacts for each PR, or sharing screenshots. However, these methods are time-consuming, do not provide a true live preview, and can miss interactive/documentation features.

Additional context

This feature would make code reviews more effective and encourage documentation improvements, as changes can be easily viewed and validated. The deployment could be handled using GitHub Actions, with each PR creating a unique link to preview the docs (e.g., memmachine.github.io/MemMachine/pr-).

Metadata

Metadata

Assignees

Labels

documentationIssues related to documentation

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions