Skip to content

docs(flaky-tests): document Test Collections feature#554

Draft
samgutentag wants to merge 1 commit intomainfrom
sam-gutentag/flaky-tests-test-collections
Draft

docs(flaky-tests): document Test Collections feature#554
samgutentag wants to merge 1 commit intomainfrom
sam-gutentag/flaky-tests-test-collections

Conversation

@samgutentag
Copy link
Copy Markdown
Member

Summary

  • New page documenting the Test Collections feature in Flaky Tests
  • Covers creating, editing, deleting collections, uploading tests, and permission model
  • Updates summary.md to add the new page to the table of contents

Source

Test plan

  • Preview in GitBook

Adds documentation for the new Test Collections UI, covering how to
create, edit, delete, and upload tests to named test groups in the
Flaky Tests product.

Source: trunk2 PR #3583

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@trunk-staging-io
Copy link
Copy Markdown

Merging to main in this repository is managed by Trunk.

  • To merge this pull request, check the box to the left or comment /trunk merge below.

After your PR is submitted to the merge queue, this comment will be automatically updated with its status. If the PR fails, failure details will also be posted here

@claude
Copy link
Copy Markdown
Contributor

claude bot commented Apr 17, 2026

Claude finished @samgutentag's task in 1m 19s —— View job


Review complete

  • Gather context
  • Read changed files
  • Review for typos, grammar, formatting, and documentation best practices
  • Post inline comments
  • Final summary

The new test-collections.md page is well-structured with a logical flow (create → upload → view → edit → delete → permissions) and clear, concise prose. No blocking issues found.

3 minor suggestions posted as inline comments:

  1. Tab ordering (line 46) — The Overview tab is always visible, but it's listed last after the tabs that only become active post-upload. Reorder to put Overview first for clarity.
  2. Button casing inconsistency (line 62) — "Delete Collection" uses title case while "Create collection" uses sentence case. Align with actual UI label casing.
  3. UI element formatting (line 65) — "Collections list" should be bolded (Collections list) to match how other UI elements are formatted throughout the doc.


* **Tests** tab: Shows all tests associated with this collection, with their flaky status, failure rates, and labels.
* **Uploads** tab: Shows the history of test uploads sent to this collection.
* **Overview** tab: Shows setup instructions and the upload configuration for this collection.
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 Overview tab is already active before any uploads (it shows setup instructions), so listing it last after the tabs that become active could confuse readers. Consider listing Overview first to match the natural reading order / UI tab order:

Suggested change
* **Overview** tab: Shows setup instructions and the upload configuration for this collection.
* **Overview** tab: Shows setup instructions and the upload configuration for this collection.
* **Tests** tab: Shows all tests associated with this collection, with their flaky status, failure rates, and labels.
* **Uploads** tab: Shows the history of test uploads sent to this collection.

Only organization admins can delete collections.

1. Navigate to the collection's **Settings** tab.
2. Click **Delete Collection**.
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.

Capitalization inconsistency: this uses title case ("Delete Collection") while line 20 uses sentence case ("Create collection"). If these reflect actual UI button labels that differ, that's fine — otherwise please align them.

Suggested change
2. Click **Delete Collection**.
2. Click **Delete collection**.

2. Click **Delete Collection**.
3. Confirm deletion in the dialog.

Deleting a collection removes it from the Collections list. Test data uploaded to the collection is not deleted from your overall test suite.
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.

"Collections list" refers to a UI element — bold it for consistency with other UI references throughout the doc.

Suggested change
Deleting a collection removes it from the Collections list. Test data uploaded to the collection is not deleted from your overall test suite.
Deleting a collection removes it from the **Collections** list. Test data uploaded to the collection is not deleted from your overall test suite.

Copy link
Copy Markdown

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Auto-approved: Claude code review passed.

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

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants