docs(kaneai): document module editing restrictions and control-flow modules - #3336
Open
anubhavsinghmaar wants to merge 12 commits into
Open
docs(kaneai): document module editing restrictions and control-flow modules#3336anubhavsinghmaar wants to merge 12 commits into
anubhavsinghmaar wants to merge 12 commits into
Conversation
…odules Modules can contain If-Else blocks and While Loops. Those blocks, and steps that create or use a variable or parameter, are locked on the Modules page and must be changed from the test case the module was authored from. Modules that contain control flow run only in KaneAI test cases and cannot be added to manual test cases in Test Manager. - kane-ai-modules: drop the removed plus (+) icon from Import the Module and document the slash command only; add Editing Restrictions and Deleting Steps Inside a Module; note the Author Module to Update Test Cases banner - modules-in-manual-testcases: document the Control-flow badge on disabled picker rows and the locked Edit Module button; add the page to the Test Manager sidebar, where it was previously unreferenced - kaneai-conditional-logic, kaneai-while-loops: state that these blocks are read-only on the Modules page and cannot be imported into manual test cases - kaneai-modules-versions-and-enhancement: cross-reference the restrictions from How Versioning Works - create-modules: same restrictions from the Test Manager side Screenshots for the new sections are still to be captured and will follow. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…details Replace the outdated Modules screenshots with current UI captures and document the behaviour they show. Screenshots (all resized to 1600px wide): - Module listing page - Create a Module, steps 1 to 3 and the saved result - Import a Module into a test, steps 1 to 3 - Edit a Module, showing the inline step editor - Delete a Module - Editing and deleting restrictions on a While Loop step Text: - Name the Read-Only label and quote the tooltips shown when edit and delete are disabled on variable, If-Else and While Loop steps - Describe the inline step editor and the Update then Save Changes flow Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
…st case creation The manual test case creation page describes importing modules but did not mention that modules containing an If-Else block or a While Loop cannot be selected there. Adds the same note used on the Import Modules into Test Cases page, with a cross-reference. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Replace the outdated screenshots on the Modules versioning page with current UI captures, resized to 1600px wide. - How Versioning Works - Accept the new version or continue with the current one - Comparing Versions - Reverting to a Previous Version - Linked Test Cases Comparing Versions and Reverting to a Previous Version both referenced image3.png, so the two sections rendered the same picture. Reverting now has its own asset showing the version list and the Revert action. The Linked Test Cases asset is shared with the Bulk Module Update page, which documents the same tab, so that page picks up the new capture too. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Manual test cases block modules that contain KaneAI instructions through the Add Module dialog, not through a badge on the module. Replace the Control-flow badge description on all three pages with what the dialog actually shows, and add a screenshot of the blocked state. Also on the Modules page documentation: - Modules can be deleted when they are not linked to any test case. The Test Manager page stated they cannot be deleted at all. - Saving an edited step is a two stage commit: Update applies the step change, Save Changes commits it. The page named a single top right update control. - State the restriction on locked steps consistently as editing, deleting and reordering across every page that mentions it. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Every screenshot in this branch now sits under the 100KB budget, down from a 902KB worst case. Applied palette quantization, which is lossless for flat UI chrome and text. Two captures that embed the marketing hero photograph resisted quantization and were also narrowed to 1440px; both render at container width so the change is not visible. Largest image is now 97KB. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This reverts commit 59fc08c.
Regenerated every screenshot from the original captures at a full 256 colour palette, which is visually lossless on flat UI and keeps text and icons sharp. The earlier attempt reduced some images to 16 and 32 colours; this replaces that. Sixteen images keep their full 1600px width. The four Create a Module captures are 1200px, still above the width the docs render them at. Two captures embed the testmuai.com hero photograph, which PNG cannot compress. They are 1000px with the browser pane softened; the KaneAI panel that the steps document stays legible. Largest image is now 99KB. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Switched the palette generator to MAXCOVERAGE, which suits these screenshots far better than the previous one: the Step 3 Execute capture drops from 331KB to 112KB at the same width and quality. Sixteen of the eighteen images now keep their full 1600px width. The two that embed the testmuai.com hero photograph are 1400px and 1350px, both still well above the width the docs render them at. No image is blurred or modified, and every one keeps a full 256 colour palette. Largest image is 98KB. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
kane-ai-modules described the modules blocked from manual test cases as containing "control flow", which leaves out variable and parameter steps. The other three pages covering the same restriction name all three. Aligned it. kaneai-while-loops stated that a module version bump makes other tests pick up the change on their next run. Versions do not propagate on their own: a test case stays on the version it references until it accepts the new one, as the versioning and import pages both describe. Also matched the sidebar label and cross-link text to the page's own sidebar_label, which read three different ways. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The banner appears on the Linked Test Cases tab, not the Overview tab, and it carries no View test cases button. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The previous pass used the MAXCOVERAGE palette generator, which spreads the palette across the colour space and shifted neutrals: whites came out cream and light greys came out blue. Regenerated with MEDIANCUT, which keeps neutrals accurate. Mean colour error drops from about 2.1 to about 0.2 on the affected captures. Twelve images keep their full 1600px width. Four Create a Module captures are 1200 to 1300px and the two containing the hero photograph are 1200px, all chosen as the widest size that stays under 100KB with an accurate palette. Largest image is 97KB. Co-Authored-By: Claude Opus 5 <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
1 participant
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 this documents
Modules can contain If-Else blocks and While Loops. Those blocks, and steps that create or use a variable or parameter, are locked on the Modules page: inline editing and drag-to-reorder are disabled, and so is delete. They must be changed from the KaneAI test case the module was authored from, which produces a new module version in the normal way.
Separately, a module that contains control flow runs only in KaneAI test cases. In the module picker of a manual test case those modules carry a Control-flow badge and cannot be selected, and Edit Module in the picker preview is locked for modules containing variables, If-Else or While.
Page by page
kane-ai-modulesmodules-in-manual-testcaseskaneai-conditional-logickaneai-while-loopskaneai-modules-versions-and-enhancementcreate-modulesChecks
sidebars.jsparses, and the new entry resolves.onBrokenLinks: 'throw'production build should pass.package-lock.jsondeliberately not included.Still to come
Screenshots for the new sections (a locked row, the Author Module banner, the Control-flow badged picker row, the locked Edit Module button) have not been captured yet and will follow in a separate PR. No image references were added or changed here.
🤖 Generated with Claude Code