docs(plans): explain test plans as a concept, not a yaml file - #19
Open
philipph-askui wants to merge 1 commit into
Open
docs(plans): explain test plans as a concept, not a yaml file#19philipph-askui wants to merge 1 commit into
philipph-askui wants to merge 1 commit into
Conversation
Lead with what a test plan is and what you do with it: a saved selection of tests and the device they run on, built with checkboxes, run with one click, and put on a schedule. The yaml is demoted to a short "under the hood" note instead of being the first thing a reader sees. Sections now follow the workflow (build, run, schedule, share via Git) so a tester learns the feature without meeting the file format first. No behaviour claims changed; all facts already shipped in integrated-task-platform#180. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed for the reader
The Test plans page currently opens with "A plan is a yaml file in `plans/`" and a yaml block, so it reads as documentation of a file format. A tester meets the storage detail before learning what the feature is.
This rewrite leads with the concept and the workflow instead:
No behaviour claims changed. Everything here already shipped:
Verification
#anchorelsewhere targets this page, so the heading restructure breaks nothing.🤖 Generated with Claude Code