From cb0f9ef5d86567e3de950d007ff9e4b9b81024e6 Mon Sep 17 00:00:00 2001 From: Sam Gutentag <1404219+samgutentag@users.noreply.github.com> Date: Mon, 16 Mar 2026 15:11:40 -0700 Subject: [PATCH] Cleanup pass: review feedback fixes and missing assets MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Addresses Claude review feedback from batch docs PRs: - Fix "XCode" → "Xcode" casing (PR #479) - Link threshold monitors in broken detection section (PR #490) - Soften "distinct series" wording (PR #490) - Split long graph view paragraph (PR #494) - Fix heading case to Title Case in Slack integration (PR #495) - Clarify "cancel or merge" wording in API reference (PR #484) - Add placeholder icons for Bamboo and Google Cloud Build CI providers Co-Authored-By: Claude Opus 4.6 --- .gitbook/assets/bamboo.png | Bin 0 -> 3719 bytes .gitbook/assets/google-cloud-build.png | Bin 0 -> 3311 bytes flaky-tests/detection.md | 4 ++-- .../get-started/ci-providers/atlassian-bamboo.md | 2 +- merge-queue/integration-for-slack.md | 6 +++--- merge-queue/reference/merge.md | 2 +- .../using-the-queue/monitor-queue-status.md | 4 +++- 7 files changed, 10 insertions(+), 8 deletions(-) create mode 100644 .gitbook/assets/bamboo.png create mode 100644 .gitbook/assets/google-cloud-build.png diff --git a/.gitbook/assets/bamboo.png b/.gitbook/assets/bamboo.png new file mode 100644 index 0000000000000000000000000000000000000000..2a497cccc22599f09bcdc71775fc451d98d145d4 GIT binary patch literal 3719 zcmeH~X;2dC8pk=O%*oQOxpcD9Q?4lPrYA+(+`!Z#%-l62wT_C4OW=}LR$8ElVk%$- zxki~NE+wU*cSl+yHKUgr@$K&r9MwHa}qM$eKc_`_g)mAyX(r*`+)xj%rMO)F={A2BcqJ+gVKP^5lP zzJt4xp}=3Cy4pcNNMrjl;A_jd0(bKz(V&wOcq0BpF{aGt{=nK?n<_juVxGx?Y%7bK zFKL0j;ic3TFoBb(?1gg?oUq>YjxUQ@?#jV)ixtzlo2!04bJn}J|9$yvE-^U@Kdz7O zN8<6T2@k-LZ$7=T0j8vdJXN=-|8PKbJ7(k~x3)k0XIlN^@?CCS{ffOX5>7**urw5L zwE`t->S3oGSv6XH;Ts8~vMGd))ud9B*B>HAj!1&XQp?d`yYNEdFRgVsOk-qB8KSN_ zyx2x;P6pE`>CqofR0$Y~nP?0uI*TZoifPRodoPeYM9fXoAKKY3wOGk?3Msz~uMpG^ zR-K|Cq?Ua@!7q@krSt@aVEJjkg<%{89?I@^e{9{idPT-9@@Ag}Irl`^K&x7K*d`+H zX~IT)Y#j4y*j^gC!- z2)^W#=wP^4H2ljJ(WeRPMLMSCxt-h0x8q~5ji9%<=a05PEl5mcD;k+HU&Q#~O{^hSf z15qt_mJNJHm!2D%fOiY4pR|8@k#$(8A-dbqznd^lb;Lo(6*Uv{vpa(C>R!ifoiK5v zGYIG4CEE#Eil(VYn^9lCHWQ@7Y|Cdjn|KcaqAM)ZU%3)BHEPSPB#+Bz_LnZHuDNI_>2W-1Nd4^!Je$Al*}RaWGnVE4;Jevj(Xb?D>E%8j8V;*P zHCjtfJEUJzqF&^UWi0UMP#(Ro%lZcN6nV@AMm6m^E54nwK3Js9B~#YZ^MmfV^9}iG z;I%a1eWP_tQN0Uw8s*|*zEu{WbeR=>W>8=^miI&%-jOlAM9X-tsSnLt8-L~Y=t1~w zeur{e`U4_s1#V*aK+Ucbd@?R;Ou9$UeLh%_?ku?(-<>y>@M-6-_2hYsArQmiy{EmA z#f$SPSi=?N%Flz{9`rBOyaZy_b*4;mp*JhLO=(JVkbkZX1HHj;h{$%CI6Orp5haSi zF2_fwA~*RP3f6JL26qK+gDVb1fPjXQo-*?oUMy3Gou>S91Hv&#^%_kN=~R&VYgm%O zVj=gmmkL2o0Ty2HF&KlL{6M1jwu@5+cCU8h&fyUj-TcF9ZX*o|Jbq=ibA)cwybQ%^s!X}XjI-GN~i zfqFcL8rv=t=V>vdfJ#5&+HaA8b01^j$9kf^=`X%}pX2JY`q9`iSYo;WBL)@m1L4Cs z+&uTG&k`uH12O%3g;C9uXw{E9grb+btYB-bSNra^7lS-5rUma3)p{?PnME~3E$!V( zxL*#cFmU8w?4fejTcdSaG~6-UM#Qwytvs{}_S7H4 zxbU-JbbJS*keTSfT6K z#%$|DGA&XW>4jk;oJ zKG}7KSX8vjAYL8jAn5k#W39ft*lCQhMSwEBoukNv{!fF^!|ajyY7=!R_ZpOsb7wcP zuCj&ewf-5*f4Asy_;Y|7T*WEj(T4T&{sKC_JrP94>eY)!3UKuFt zv**=GZEJ`ZYF3!}%+YSP9SJu+_7>D+hT@YdIc?*1%M&hP7Y#2*5i$*ev3I_gmS-`I;C~>#@BXn<9v?74thhgmh8FOdMxL%)5+R@AM2$wq&|$x2WHIB>>R+$Wdjh% zd4g2b_G*S5+YmSy$G;mVYO#Fg85uuPOYhC+>Zs`iosrnFJHbm+VEq~pW3%~N?S;@T zyM}-jvH0CW*toMVi4`Z9)r4ulYNa$@iLA-2F-UAz>bF<2&2EK849f8It-c=r_>{~a)%~& zi}GE<}#n)LcK1u4pg$0wFc4(%~kdRetIU^W!FqcwN`jAT`O zpUM0vPJpkLq4f+9~0aISJ=))M#X@@Muf-%>9cRWm|fyTCT=DSDnpWKN6t zE&8)%lc}_m=JFhPwU9Rjy|;C74K{gyYeA~mjK|W(9$%dsk+pJX4>*_;{4^Ctf2%G^ z?eR=8H1+uO4hDmirjf&N)aMZIq4|_CbY#Q{p{$o`&mS3jj7QrVJ+5TRZiJD>t7FM>V7S^Vgwg@XLdrM1u3u_Y#3wsL-QgP?Xe*sZ3=OZs%{%c^YGu?Ru iF#1mgbYv7V9vvEm`fH|^8&tf(0HDsEPK;wAng0YG#v=Ow literal 0 HcmV?d00001 diff --git a/.gitbook/assets/google-cloud-build.png b/.gitbook/assets/google-cloud-build.png new file mode 100644 index 0000000000000000000000000000000000000000..1a3bd9dd75698de341f93d3828e4207453ef19e8 GIT binary patch literal 3311 zcmeHKX*3(?8ctVt7?-xAOFEd2DV^FwsMzjQRncgpsaT?xSS}G;Xe=dKszr6Cwe=QJ zCDuwPi3p)4Lu-wSJ&7$v1+kUbA~!QX?)^1C@40{GJLh?ybKdVf=ljm{z2EuXFXg6# zjl3*S761Uq+g`ikDCG~oL-C+AhF8p_O6fb)HAg4_5TgzNBqRX$8j0s?(=ZuJEb1vAJE0cNoY{!E(oGE9)(|zx5RTzutF>WOJJ_#GZ~2| zmGd(*Gl~F{cmnB-E&!04>Ulsh@h|+(Jz(A(I<+FXY(KD8HyLaUL>SejxwCz;3*EGD z^cmCFla+UJ;9XtXwHfAoT--0uW)0t9wos-v=Me}|DM3}Pw|c5}_0U1W&Ru9A)`p?f zsPLp-S91X@t}nzCspndJzEtRy)M`ST(+Gh(DdEvHB8tW^2L`D5a>p52Hl z%Bt(q+vd#{=63M#eyBgAB@P?Dk6B*m_H!E=?eVxfX8c~?@IvteC|XZ#uc0g6rBKxg zQgqgB$3Tel(+N9|e9{RK2;oDOHmfU1Gg#Ip`dQ$m6OoMZ=r~H-dl3l-m&^*L_BXGC zt$lwaem{7D2!H8lxAC{MDAv}mQTFx5Pi; z9YLf=Rg3ie6PEmM*ep|*)aEh*@602n#2G8wBTijVXj-^DUQ!XJYv#4xSG0UMxL=u+ z=X|HsI^Gnracm9_hVh)l%Xs)S8|_YwzvvtZ6Q_n}|6yd8_w%zs23*%@(JzC~)>sC^ zu?>;(Of>T2L|%2vE|i^;%Gj&dWWP+ep_?ocT|Oq!gkQ~m8nPkKs>rqdcRvWq{Nx)O zhRyXh`RcXl%HAO6jRgxvp>QiURlihfkfVI3#|GyWW=;6ZJ3{Fc3gEAy;cC466%$0n^JusU8 zI}XE(dRxfn9y5*Mlwz7g?-BSIBD~B|=B}>_)&U$B{GxCi2&#de$iP~y4~+HRdI}#7 zXU%#Spz)q^Jklmc5c_4KXCE{=p_0>dp=Z{)vZRt{M;y@}MBcY&+Q@HMR%9AkANeM3 z*6&PYh2W5J`PM-AA))?n;N|lC;Uzh2GAAZB*^IV}$d>MPMWaxmK_SM%@l+FMyfj(H z6wfxG0O!e3^^6IAv4E6 zG7{m`~K)?e5%5Jsx)$=ps zgD>UvgwnF8e&dw>{G78z1a>eVXO2Hw8ThkZ7=1V`93J7bb%!}hpyWOU_tGUF9-$9s z4x2R;ZZifAa0QgosCFfljQa0dYW<6GoDrnuwGFLK@IO;rNwPXL4O&QB4y6>6r3?#9 z)#lak3>Yi0`s7)6(Kn`@_&nC`Ap1hxNQgek>4=9ybC_QS!t4t!8w6)91gKhK!5qqn!mXbzI2PDUwW2Rp0 z-c~|aX<8xuUn{c^@ zd!@0~ma*ja;_19Nl3ea(_al)S^S)G}@iad$t9jYGu5pkS=3bf`d-x&z@vwH|*ry?o z=(!5wdv1H9>uYM=Rss9=HqDz#vRa%`k8dX(5m`pmaJ`rA4X`$n7yK=$=EbjdKJzxu zmVCm$%G_DdOq?dYrroO#%>24_&1Bhfw8_gO-xuAd(G;!AtkSUpY8%XcEg0Fc;w#Qw zM?fiai}%qP+*2jW&J$XASm$o`#okuy0=(c!Bq}K5>RkJx@tFeql)WKm2G;@m*scx| zY_#^}ck5C#8f{+u+#{#F_F!TGca)nin5Ut}ZEM+Y zcWa&)vN|dbWbMZs7Paf>dtwYY)%qCIVbF$hafq@{HzfzB!8%5BsY7D>DP^AXn05k6iKz7SNnuap2F zJ&=*Mo`JT$5gY`9=<7p3hMIbM5IsG`)BC^wI{qubg!lybMgO_L%lax+D!A~U6(RyK czSsyaOz59$jBfe|NHqXkYlkbO%bpMZ4f~wZsQ>@~ literal 0 HcmV?d00001 diff --git a/flaky-tests/detection.md b/flaky-tests/detection.md index 6e0f9fad..edfaf19b 100644 --- a/flaky-tests/detection.md +++ b/flaky-tests/detection.md @@ -107,14 +107,14 @@ Trunk classifies all tests into one of three categories based on the history of ### How Trunk detects broken tests -Threshold monitors detect broken tests alongside flaky tests. When a test's failure rate exceeds the configured threshold and the failures are consistent rather than intermittent, Trunk classifies the test as **Broken** instead of **Flaky**. +[Threshold monitors](dashboard.md#monitors) detect broken tests alongside flaky tests. When a test's failure rate exceeds the configured threshold and the failures are consistent rather than intermittent, Trunk classifies the test as **Broken** instead of **Flaky**. The key difference is the failure pattern: * **Flaky**: Failures are intermittent — the test sometimes passes and sometimes fails on the same code. * **Broken**: Failures are consistent — the test fails reliably above the threshold without intermittent passes. -Broken detection events appear in the test case detail view alongside flaky detection events. In the events panel, broken events are displayed as a distinct series so you can track when tests transition between healthy, flaky, and broken states. +Broken detection events appear in the test case detail view alongside flaky detection events. In the events panel, broken and flaky events are shown as separate series so you can track when tests transition between healthy, flaky, and broken states. {% hint style="info" %} A test can transition between states over time. For example, a test might start as healthy, become flaky as a race condition surfaces, and eventually be classified as broken if the underlying issue causes consistent failures. diff --git a/flaky-tests/get-started/ci-providers/atlassian-bamboo.md b/flaky-tests/get-started/ci-providers/atlassian-bamboo.md index 75276aea..eec48cd6 100644 --- a/flaky-tests/get-started/ci-providers/atlassian-bamboo.md +++ b/flaky-tests/get-started/ci-providers/atlassian-bamboo.md @@ -128,7 +128,7 @@ variables: ``` {% endtab %} -{% tab title="XCode" %} +{% tab title="Xcode" %} ```yaml version: 2 plan: diff --git a/merge-queue/integration-for-slack.md b/merge-queue/integration-for-slack.md index 217581fc..b313ce5a 100644 --- a/merge-queue/integration-for-slack.md +++ b/merge-queue/integration-for-slack.md @@ -80,7 +80,7 @@ To receive personal Slack notifications, you'll need to connect both your GitHub The Trunk Slack app's **Home** tab provides a personal merge queue dashboard directly in Slack. Open the Trunk app in Slack and click the **Home** tab to see an overview of your merge queue activity. -### What you'll see +### What You'll See The Home tab displays the following sections: @@ -93,13 +93,13 @@ The Home tab displays the following sections: Each PR entry shows the PR title, number, a link to the Trunk dashboard, and a link to the GitHub PR. All data is scoped to your PRs via your linked GitHub account. -### Linking your account +### Linking Your Account 1. Open the Trunk app in Slack and go to the **Home** tab 2. Click **Link Account** to connect your Trunk account 3. Click **Connect GitHub** to link your GitHub account (required for PR tracking and most notifications) -### Managing notification preferences +### Managing Notification Preferences You can toggle notification topics on or off directly from the Home tab — no need to visit the Trunk web UI. Changes take effect immediately. The available topics are the same as those listed in [Available Notification Topics](integration-for-slack.md#available-notification-topics). diff --git a/merge-queue/reference/merge.md b/merge-queue/reference/merge.md index c068c4e6..4448117b 100644 --- a/merge-queue/reference/merge.md +++ b/merge-queue/reference/merge.md @@ -180,7 +180,7 @@ Use these endpoints to create, configure, and manage merge queues. Each queue ta {% endopenapi-operation %} {% hint style="warning" %} -The queue must be empty before it can be deleted. Cancel or merge all enqueued PRs first. +The queue must be empty before it can be deleted. Cancel all enqueued PRs or wait for them to be merged first. {% endhint %} {% openapi-operation spec="trunk-api" path="/getQueue" method="post" %} diff --git a/merge-queue/using-the-queue/monitor-queue-status.md b/merge-queue/using-the-queue/monitor-queue-status.md index 75d0b506..407c0800 100644 --- a/merge-queue/using-the-queue/monitor-queue-status.md +++ b/merge-queue/using-the-queue/monitor-queue-status.md @@ -41,7 +41,9 @@ View status of the queue and recent activity in the **Queue** tab ### Graph view -The graph view shows all PRs currently being tested by Trunk Merge Queue and their relationships. Each node represents a pull request, and each edge indicates that the PR is testing with the item above and depends on it. All edges point towards the target branch; as items merge, the affected queues restructure. If running in `Single` mode, this will be a single line showing the testing and merging process. +The graph view shows all PRs currently being tested by Trunk Merge Queue and their relationships. Each node represents a pull request, and each edge indicates that the PR is testing with the item above and depends on it. All edges point towards the target branch; as items merge, the affected queues restructure. + +If running in `Single` mode, this will be a single line showing the testing and merging process. #### Reading the graph