Add AI-ingestible framework brief#207
Open
Ulrond wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new “AI Brief” documentation page intended to act as a single-file reference for RAFT’s architecture, APIs, configuration schemas, and common usage patterns.
Changes:
- Introduces
docs/ai-brief.mdwith a consolidated overview of framework structure and key components. - Documents core classes (test harnesses, device/console abstractions), YAML schemas, and example test patterns.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
| | WARNING | WARNING | 30 | | ||
| | ERROR | ERROR | 40 | | ||
| | CRITICAL | CRITICAL | 50 | | ||
| | FATAL | FATAL | 100 | |
Comment on lines
+263
to
+267
| logs/<rackName>/<slotName>/<YYYYMMDD-HH-MM-SS>/ | ||
| test_summary.log | ||
| test_summary.log.csv | ||
| <testName>-<qcId>/ | ||
| test-0.log |
Comment on lines
+268
to
+271
| test-0.log.csv | ||
| screenImages/ | ||
| captureImages/ | ||
| ``` |
| | `"apc"` | `powerAPC` | `ip`, `username`, `password`, `outlet` | | ||
| | `"apcAos"` | `powerApcAos` | `ip`, `username`, `password`, `port` (23), `outlet` | | ||
| | `"olimex"` | `powerOlimex` | `ip`, `port`, `relay` | | ||
| | `"kasa"` | `powerKasa` | `ip`, `options` ("--plug" or "--strip"), `args` ("--index N") | |
|
|
||
| Uses `pyserial`. | ||
|
|
||
| Config fields: `type: "serial"`, `port` (e.g. "/dev/ttyUSB0"), `baudRate` (default 115200), `dataBits` (8), `stopBits` (1), `parity` ("None"), `flowControl` (False), `prompt`. |
| self.log.stepStart("Power cycle DUT") | ||
| self.powerControl.reboot() | ||
| self.log.step("Wait for device to come back") | ||
| time.sleep(30) |
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.
Summary
docs/ai-brief.md-- a comprehensive single-file brief capturing python_raft's complete architecture, API surface, configuration schema, and usage patternsCloses #206
Test plan