Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/journeys/manifests/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Journey Manifests
6 changes: 6 additions & 0 deletions docs/operations/iconography/SPEC.md
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`.
121 changes: 121 additions & 0 deletions docs/operations/journey-traceability.md
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`
Comment on lines +116 to +120
Copy link
Copy Markdown

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.md and docs/governance/security-policy.md that 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 🤖
This is an **Architect / Logical Review** comment left during a code review. These reviews are first-class, important findings — not optional suggestions. Do NOT dismiss this as a 'big architectural change' just because the title says architect review; most of these can be resolved with a small, localized fix once the intent is understood.

**Path:** docs/operations/journey-traceability.md
**Line:** 116:120
**Comment:**
	*HIGH: The "Related" section references governance paths `docs/governance/agent-local-parity.md` and `docs/governance/security-policy.md` that do not exist anywhere in this repository, leaving readers without resolvable links to those supposed source documents.

Validate the correctness of the flagged issue. If correct, How can I resolve this? If you propose a fix, implement it and please make it concise.
If a suggested approach is provided above, use it as the authoritative instruction. If no explicit code suggestion is given, you MUST still draft and apply your own minimal, localized fix — do not punt back with 'no suggestion provided, review manually'. Keep the change as small as possible: add a guard clause, gate on a loading state, reorder an await, wrap in a conditional, etc. Do not refactor surrounding code or expand scope beyond the finding.
Once fix is implemented, also check other comments on the same PR, and ask user if the user wants to fix the rest of the comments as well. if said yes, then fetch all the comments validate the correctness and implement a minimal fix

- `hwLedger/vendor/phenotype-journeys/README.md`
Loading