Add documentation preview

[kdheepak]

No description provided.

[github-actions]

PR Preview Action v1.4.4
Preview removed because the pull request was closed.
2023-08-22 16:29 UTC

[kdheepak]

I had to make changes to the github workflow for previews to work, i.e. changing from deploying using a Github Action to using the classic gh-pages branch. This currently has broken the default documentation link for the ratatui-book.

I'm going to merge this without review. But feel free to still leave comments on this PR. I'll address them in subsequent PRs.

[joshka]

For this, do you end up with a git repo having a million commits? I couldn't quite get the sense of how that action worked from a quick read of the overview.

[kdheepak]

There will be a new commit that adds the preview content in a separate folder:

It also removes the content after PR is merged.

We can nuke the gh-pages at any point (while PRs are not open) and we will be fine, so I think this is a good system.

[kdheepak]

At the moment, the action doesn't remove .nojekyll files. There's an issue to track this:

rossjrw/pr-preview-action#15

We can remove it ourselves manually or as part of the closed event on the action.

[joshka]

Ah. That was what I missed - the tool users try gh pages branch to track this.

[kdheepak]

Yes. That’s why it is important to use the keep_files: true when deploying the build on the main branch to gh-pages.