fix: update preview workflow

[banana-three-join]

Notes for Reviewers

• Carry over work from [chore]: update workflow usage meshery-extensions/tcslabs-academy#63

Signed commits

• Yes, I signed my commits.

Summary by CodeRabbit

• New Features
  • Added automated documentation previews for relevant pull requests.
  • Preview sites are built with pull-request-specific URLs and hosted on GitHub Pages.
  • Pull requests receive a link to the published documentation preview.
  • Preview pages are excluded from search engine indexing.
  • Older previews are automatically pruned to maintain a manageable collection.
• Chores
  • Replaced the previous documentation preview workflow with separate build and deployment workflows.

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 90f3d13a-0124-40c4-bb0c-5d4cb2f1a508

📥 Commits

Reviewing files that changed from the base of the PR and between 6e1c9b4 and 54afb39.

📒 Files selected for processing (3)

• .github/workflows/build-and-preview-docs.yml
• .github/workflows/build-docs-preview.yml
• .github/workflows/deploy-docs-preview.yml

---

📝 Walkthrough

Walkthrough

The PR removes the previous documentation preview workflow and adds separate build and deployment workflows. The new workflows build PR previews, upload artifacts, deploy to PR-specific GitHub Pages paths, comment preview URLs, and prune older previews.

Changes

Documentation preview lifecycle

Layer / File(s)	Summary
Build and package documentation previews .github/workflows/build-docs-preview.yml	The workflow builds pull request documentation with pinned toolchains, preview-specific metadata, and a disallow-all robots.txt. It uploads the site and PR metadata as a seven-day artifact.
Deploy previews and notify pull requests .github/workflows/deploy-docs-preview.yml	The workflow validates artifact metadata, deploys the preview to a PR-specific gh-pages path, and creates or updates a sticky pull request comment.
Prune expired previews and notify pull requests .github/workflows/deploy-docs-preview.yml	The retention job keeps six previews, retries concurrent gh-pages updates, and reports removed previews in pull request comments.

Estimated code review effort: 3 (Moderate) | ~25 minutes

Possibly related PRs

• layer5io/docs#1101: Refactors the documentation preview workflow that this PR splits into separate build and deployment workflows.

✨ Finishing Touches 💡 1

🛠️ Fix failing CI checks 💡

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[github-actions]

Preview deployment for PR #1181 removed.

This PR preview was automatically pruned because we keep only the 6 most recently updated previews on GitHub Pages to stay within deployment size limits.

If needed, push a new commit to this PR to generate a fresh preview.