Repository navigation
docs: organize toolkit by lifecycle - #82
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the project’s primary documentation to present the QA/QC template library by BESS delivery lifecycle, and adds a small fictional example record that can be run through the existing readiness audit tooling.
Changes:
- Renames “Planned Contents” to “Toolkit Contents” and reorganizes the template list by lifecycle stage.
- Adds a new “Fictional Worked Example” section in the README with an executable audit command.
- Introduces
examples/lifecycle-worked-example.mdas a fabricated, runnable readiness-record example.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Reorganizes the template catalog by lifecycle and links to a fictional, runnable example. |
| examples/lifecycle-worked-example.md | Adds a fictional readiness table intended to be consumed by the readiness audit scripts. |
Suppressed comments (1)
README.md:99
- Spelling is inconsistent in this paragraph: "catalog" earlier in the README vs "catalogue" here. Recommend standardizing on one spelling for consistency.
The [lifecycle worked example](examples/lifecycle-worked-example.md) is a
small, fictional record that demonstrates the existing readiness fields across
the lifecycle catalogue. It is illustrative only: its fabricated evidence IDs
are not compliance evidence and must not be used to support a real energization
or handover decision.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+11
to
+19
| | Lifecycle Stage | Item | Owner | Target Close Date | Evidence Link | Status | | ||
| | --- | --- | --- | --- | --- | --- | | ||
| | Design / Supplier Review | Approved supplier drawing register | Design review | 2026-01-10 | EX-DES-001 | Closed | | ||
| | FAT | Factory witness test pack | FAT lead | 2026-01-20 | EX-FAT-001 | In progress | | ||
| | Site / SAT | Protection and interlock SAT | Site QA/QC | 2026-01-22 | EX-SAT-001 | Open | | ||
| | Commissioning | Instrument calibration register | Commissioning lead | 2026-01-12 | EX-COM-001 | Closed | | ||
| | Energization | Energization readiness gate | Electrical lead | 2026-01-14 | EX-ENG-001 | Approved | | ||
| | Handover | Controlled handover document index | Document control | 2026-01-25 | EX-HAN-001 | In progress | | ||
| | Warranty / O&M | O&M training record | O&M coordinator | 2026-01-30 | EX-OM-001 | Open | |
Comment on lines
+26
to
+28
| The catalogue follows a typical BESS delivery lifecycle. A template may be | ||
| adapted for another gate when the project plan or contract assigns it there; | ||
| the grouping below is a navigation aid, not a required sequence. |
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: Rename Planned Contents to Toolkit Contents, organize all 35 templates by delivery lifecycle, and add a clearly fictional worked example with executable audit inputs. Validation: 142 unit tests, 35-template validation, readiness gate PASS with zero findings, Markdown links, and diff check.