Skip to content

docs bot: format generated docs PRs before committing - #5226

Merged
kompfner merged 1 commit into
mainfrom
pk/docs-bot-prettier
Aug 5, 2026
Merged

docs bot: format generated docs PRs before committing#5226
kompfner merged 1 commit into
mainfrom
pk/docs-bot-prettier

Conversation

@kompfner

@kompfner kompfner commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

The docs repo had drifted out of Prettier style and now enforces it via a pre-commit hook (pipecat-ai/docs#1060). This bot was the largest single source of that drift, since it commits generated MDX with no formatting step.

This is the pipecat-docs-bot side of the Prettier enforcement change: it formats the pages a run touched before committing, using the docs repo's pinned Prettier and Node so its output matches what contributors produce.

Depends on pipecat-ai/docs#1060, which adds the package-lock.json and .nvmrc this reads. Merge that one first.

The workflow installs the docs repo's pinned toolchain and runs its Prettier
over the pages a run touched, so generated docs PRs land already formatted.
Scoping to touched pages keeps the PR diff limited to the changes under review,
and Node comes from the docs repo's .nvmrc rather than the runner image.
@codecov

codecov Bot commented Aug 5, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@markbackman markbackman left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice improvement!

@mattieruth mattieruth left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kompfner
kompfner merged commit 08f7aed into main Aug 5, 2026
6 checks passed
@kompfner
kompfner deleted the pk/docs-bot-prettier branch August 5, 2026 18:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants