Skip to content

[🤖 automated] Restore README-backed docs homepage and add Playwright guidance#89

Merged
bbrzoska merged 4 commits into
mainfrom
heibot/docs/readme-homepage-playwright.tjzi
Apr 23, 2026
Merged

[🤖 automated] Restore README-backed docs homepage and add Playwright guidance#89
bbrzoska merged 4 commits into
mainfrom
heibot/docs/readme-homepage-playwright.tjzi

Conversation

@zendesk-heibot
Copy link
Copy Markdown
Contributor

@zendesk-heibot zendesk-heibot Bot commented Apr 1, 2026

Note

🤖 This PR was generated by HeiBot from the following prompt:

Proceed with improvements to the documentation. While you're at it, a recent upgrade caused the docs to no longer show the root README.md in the docusaurus pages as the default home page. Let's restore that functionality and ensure the embedded image is also shown/published.
make sure to run prettier formatter afterwards so files use valid formatting.


Summary

  • replace the custom Docusaurus landing page with a generated homepage synced from the repository root README.md
  • copy README media assets into the docs static output and wire homepage sync into the docs start, build, and deploy scripts
  • add a dedicated Playwright guide for installing Laika interceptors before initial requests fire, and link it from the README and existing docs pages
  • fix the stale API-reference link used from the README/homepage flow

Testing

  • yarn rrun prettier --check README.md docs/README.md docs/package.json docs/sidebars.js docs/scripts/sync-homepage-from-readme.mjs docs/src/pages/index.mdx docs/docs/how-to-install.md docs/docs/resetting-between-tests.md docs/docs/usage-in-playwright.md
  • cd docs && yarn build

Notes

  • removed the old custom React landing page and its unused CSS module in favor of the generated README-backed MDX page
  • verified the built homepage now emits /laika/media/... asset URLs so the embedded README images publish correctly under the site base path

Tip

💬 To make additional changes, continue the conversation in the original Slack thread, or trigger a new workflow dispatch with restore-session-from-run-id: 23865408578.

Co-authored-by: Bazyli Brzóska <bbrzoska@zendesk.com>
Co-authored-by: Codex <199175422+chatgpt-codex-connector[bot]@users.noreply.github.com>
@zendesk-heibot zendesk-heibot Bot added the heibot Pull request generated by HeiBot label Apr 1, 2026
@zendesk-heibot zendesk-heibot Bot added the heibot Pull request generated by HeiBot label Apr 1, 2026
Co-authored-by: Bazyli Brzóska <bbrzoska@zendesk.com>
Co-authored-by: Codex <199175422+chatgpt-codex-connector[bot]@users.noreply.github.com>
@bbrzoska bbrzoska marked this pull request as ready for review April 23, 2026 18:39
@bbrzoska bbrzoska requested a review from a team as a code owner April 23, 2026 18:39
bbrzoska and others added 2 commits April 23, 2026 11:41
Co-authored-by: Bazyli Brzóska <bbrzoska@zendesk.com>
Co-authored-by: Codex <199175422+chatgpt-codex-connector[bot]@users.noreply.github.com>
@bbrzoska bbrzoska merged commit f10f0f3 into main Apr 23, 2026
9 checks passed
@bbrzoska bbrzoska deleted the heibot/docs/readme-homepage-playwright.tjzi branch April 23, 2026 18:53
@github-actions
Copy link
Copy Markdown

🎉 This PR is included in version 1.5.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

heibot Pull request generated by HeiBot released

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant