-
Notifications
You must be signed in to change notification settings - Fork 0
docs: add journey-traceability + iconography implementation #44
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| # Journey Manifests |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| # Iconography Standard | ||
|
|
||
| Implements the [phenotype-infra iconography standard](https://github.com/kooshapari/phenotype-infra/blob/main/docs/governance/iconography-standard.md). | ||
|
|
||
| Three styles: Fluent (stroke), Material (filled+outlined), Liquid Glass (blur). | ||
| All icons: 24×24 SVG, `currentColor`, `role="img"`, `aria-label`. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| # Journey Traceability Standard | ||
|
|
||
| - **Status:** Draft | ||
| - **Date:** 2026-04-30 | ||
|
|
||
| ## Purpose | ||
|
|
||
| Every repo in the Phenotype ecosystem should carry visible journey evidence for | ||
| the flows it documents. A journey is not just prose. It is a traceable bundle of: | ||
|
|
||
| - the page that explains the flow | ||
| - keyframe images that show the important states | ||
| - a recording that shows the full interaction | ||
| - metadata that ties the evidence back to a repo, run, and purpose | ||
|
|
||
| This standard makes those artifacts consistent across repos so docs, audits, and | ||
| handoffs all point to the same evidence shape. | ||
|
|
||
| ## Canonical Pattern | ||
|
|
||
| Use the hwLedger pattern as the reference implementation: | ||
|
|
||
| - `ShotGallery` for keyframes | ||
| - `RecordingEmbed` for the full recording | ||
| - `cli-journeys/keyframes/<journey>/frame-###.png` for frame assets | ||
| - a stable `tape` id for the recording reference | ||
| - renderer components sourced from `phenotype-journeys` | ||
|
|
||
| If a repo vendors the viewer package, keep that vendoring pattern documented in | ||
| the repo itself so the journey page remains reproducible. | ||
|
|
||
| Example: | ||
|
|
||
| ```md | ||
| <ShotGallery | ||
| title="plan - help, run, and VRAM breakdown" | ||
| :shots='[ | ||
| {"src":"/cli-journeys/keyframes/plan-help/frame-005.png","caption":"hwledger plan --help"}, | ||
| {"src":"/cli-journeys/keyframes/plan-deepseek/frame-003.png","caption":"Typical plan output: VRAM breakdown + architecture detection"} | ||
| ]' /> | ||
|
|
||
| <RecordingEmbed tape="plan-deepseek" kind="cli" caption="CLI plan: DeepSeek-V3 -> live architecture detection + colored VRAM bands" /> | ||
| ``` | ||
|
|
||
| ## Required Artifacts | ||
|
|
||
| Each documented journey should include: | ||
|
|
||
| 1. A short page section describing the user intent and expected outcome. | ||
| 2. At least one `ShotGallery` block when the journey has visible UI or CLI | ||
| state transitions. | ||
| 3. At least one `RecordingEmbed` when the flow is worth replaying end-to-end. | ||
| 4. Stable asset names that can be re-used from docs, audits, and changelogs. | ||
| 5. A link back to the repo or work item that produced the evidence. | ||
|
|
||
| ## Asset Layout | ||
|
|
||
| Recommended storage pattern: | ||
|
|
||
| - keyframes under `/cli-journeys/keyframes/<journey>/frame-###.png` | ||
| - recordings referenced by stable tape id, for example `plan-deepseek` | ||
| - doc pages colocated with the feature docs that explain the journey | ||
|
|
||
| If a repo does not have a docs-site, use the equivalent canonical docs folder | ||
| and keep the same naming rules. | ||
|
|
||
| ## Metadata Contract | ||
|
|
||
| Every journey page should carry enough context for later traceability: | ||
|
|
||
| - repo name | ||
| - journey id | ||
| - flow name | ||
| - owner or team | ||
| - related issue, ADR, PR, or worklog reference | ||
| - capture date | ||
| - environment used for the capture | ||
|
|
||
| Keep this data close to the journey page so it is visible with the evidence. | ||
|
|
||
| ## Minimum Acceptance Criteria | ||
|
|
||
| A repo is considered to have journey traceability only when: | ||
|
|
||
| - the repo docs include the flow narrative and the evidence bundle | ||
| - the keyframes show the important state transitions, not just the happy path | ||
| - the recording can be replayed or re-embedded from the stable tape id | ||
| - the docs point to the source of truth for the capture, not just a screenshot dump | ||
|
|
||
| ## Adoption Checklist | ||
|
|
||
| For each repo: | ||
|
|
||
| 1. Identify the top user-visible or operator-visible flows. | ||
| 2. Add one journey page per flow in the repo docs. | ||
| 3. Capture keyframes for the important states. | ||
| 4. Record a replay and register its tape id. | ||
| 5. Add the evidence to the docs page with `ShotGallery` and `RecordingEmbed`. | ||
| 6. Link the page from the repo README or docs index. | ||
|
|
||
| ## Suggested Rollout Order | ||
|
|
||
| Start where the docs surface is already central: | ||
|
|
||
| 1. `phenodocs` - docs hub; highest leverage for propagating the standard. | ||
| 2. `PhenoHandbook` - patterns registry; good home for reusable journey examples. | ||
| 3. `PhenoProject` - workspace-level docs and worklogs. | ||
| 4. Product repos with active docs sites or docs portals. | ||
| 5. Smaller repos and supporting tools after the central hubs are covered. | ||
|
|
||
| ## Exceptions | ||
|
|
||
| If a journey cannot yet be captured, document the blocker explicitly and link the | ||
| open issue or missing dependency. Do not silently omit the evidence. | ||
|
|
||
| ## Related | ||
|
|
||
| - `docs/governance/agent-local-parity.md` | ||
| - `docs/governance/security-policy.md` | ||
| - `hwLedger/docs-site/reference/cli.md` | ||
| - `hwLedger/vendor/phenotype-journeys/README.md` | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🟠 Architect Review — HIGH
The "Related" section references governance paths
docs/governance/agent-local-parity.mdanddocs/governance/security-policy.mdthat do not exist anywhere in this repository, leaving readers without resolvable links to those supposed source documents.Suggestion: Update the "Related" section so that each referenced document is actually resolvable: either create these governance docs under the referenced paths, adjust the paths to existing in-repo files, or replace them with explicit external URLs to the correct locations.
Fix in Cursor | Fix in VSCode Claude
(Use Cmd/Ctrl + Click for best experience)
Prompt for AI Agent 🤖