Skip to content

Condense docs bot PR template addition - #4326

Merged
omehegan merged 1 commit into
mainfrom
docs-bot-template-v2
Sep 4, 2026
Merged

Condense docs bot PR template addition#4326
omehegan merged 1 commit into
mainfrom
docs-bot-template-v2

Conversation

@omehegan

@omehegan omehegan commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

Description

After internal discussion we decided it was best to condense the docs section of the PR template. No code changes here.

@omehegan
omehegan requested review from a team as code owners September 4, 2026 01:17

@buildsworth-bk-app buildsworth-bk-app Bot 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.

The renamed heading breaks the docs bot's deterministic extraction, so the checked publication instruction will not reach generated docs PRs. One blocking issue is inline.

Want to dig deeper?

Paste this into your agent to explore the findings from this review's Buildkite build:

Download the buildsworth logs from build 25355, then answer my questions about the findings.

Install the reading-buildsworth-logs skill to run this.

About buildsworth

Model: gpt-5.6-sol with xhigh thinking.

How to request a review: Comment @buildsworth-bk review on the PR, or request buildsworth-bk as a reviewer.

Risk labels (how buildsworth classifies risk) — buildsworth classifies risk itself from the diff. Unless repository policy already allows L2 approval, grant it by mentioning @buildsworth-bk (see approval ceiling and L2 approval grant):

  • L1 — Low risk (dep bumps, docs/copy, lockfiles, small presentational fixes). buildsworth may approve by default.
  • L2 — Standard risk (new UI, additive API fields, refactors). Approved only when repository policy or a verified grant allows it; otherwise comment-only.
  • L3 — High risk (auth, migrations, payments, secrets, perf-critical pipeline paths). Human review always required.

**Publication notes:**

<!-- If documentation must be held or needs availability language, explain what reviewers should know and when it can be published. -->
### Public documentation

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.

Blocking: The docs writer's extraction step currently matches only Documentation and publication as the section heading. With this rename, PRs created from the template produce an empty PUBLICATION_READINESS, so generated docs PRs get the “did not provide publication-readiness information” fallback instead of the checked instruction. Please preserve the existing heading or update the consumer before this lands.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@buildsworth-bk I will address that in a separate PR.

@pda pda left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I assume the downstream consumer will be updated subsequently 👍🏼

@moskyb moskyb added the internal Non-user facing, internal change. label Sep 4, 2026
@omehegan

omehegan commented Sep 4, 2026

Copy link
Copy Markdown
Contributor Author

@buildsworth-bk review please.

@buildsworth-bk-app
buildsworth-bk-app Bot dismissed their stale review September 4, 2026 05:14

Previous concerns have been addressed.

@buildsworth-bk-app buildsworth-bk-app Bot 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.

The downstream extraction update is deferred to a separate PR, so I’m leaving this as a comment rather than approving this revision.

Want to dig deeper?

Paste this into your agent to explore the findings from this review's Buildkite build:

Download the buildsworth logs from build 25545, then answer my questions about the findings.

Install the reading-buildsworth-logs skill to run this.

@omehegan
omehegan merged commit 6991ebb into main Sep 4, 2026
5 of 6 checks passed
@omehegan
omehegan deleted the docs-bot-template-v2 branch September 4, 2026 05:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Non-user facing, internal change.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants