-
Notifications
You must be signed in to change notification settings - Fork 0
docs(task-9): README rewrite, CLAUDE.md, task_009 completion #27
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
Show all changes
9 commits
Select commit
Hold shift + click to select a range
6e096b8
docs(readme): Rewrite for accuracy, clarity, and completeness (Task 9.2)
ImmortalDemonGod d25cfda
docs(taskmaster): Mark task_009 and all subtasks done
ImmortalDemonGod 0ffef18
docs(claude): Add CLAUDE.md with AIV workflow, gotchas, and project c…
ImmortalDemonGod 744720f
docs(aiv): verification packet for change 'task-9-readme-quality'
ImmortalDemonGod 7e2cf5d
docs(aiv): fix packet — add Class E, fill classification rationale
ImmortalDemonGod 1ea3f4f
docs(readme): Remove migration guide and status table
ImmortalDemonGod 4e96dae
docs(aiv): verification packet for change 'task-9-readme-cleanup'
ImmortalDemonGod 5ea2ea0
docs(aiv): fix packet — add Class E, fill classification_rationale
ImmortalDemonGod 2f919ce
docs(aiv): fix packet — correct risk_tier R1→R0 to match rationale
ImmortalDemonGod 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
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,62 @@ | ||
| # AIV Evidence File (v1.0) | ||
|
|
||
| **File:** `CLAUDE.md` | ||
| **Commit:** `d25cfda` | ||
| **Generated:** 2026-03-28T02:15:14Z | ||
| **Protocol:** AIV v2.0 + Addendum 2.7 (Zero-Touch Mandate) | ||
|
|
||
| --- | ||
|
|
||
| ## Classification (required) | ||
|
|
||
| ```yaml | ||
| classification: | ||
| risk_tier: R0 | ||
| sod_mode: S0 | ||
| critical_surfaces: [] | ||
| blast_radius: "CLAUDE.md" | ||
| classification_rationale: "New documentation file only; no executable code" | ||
| classified_by: "Miguel Ingram" | ||
| classified_at: "2026-03-28T02:15:14Z" | ||
| ``` | ||
|
|
||
| ## Claim(s) | ||
|
|
||
| 1. CLAUDE.md created with full aiv commit workflow, E010 false-positive trap, FILE argument constraints, and architecture reminders | ||
| 2. Loaded automatically by Claude Code at session start — no need to repeat instructions each session | ||
| 3. No existing tests were modified or deleted during this change. | ||
|
|
||
| --- | ||
|
|
||
| ## Evidence | ||
|
|
||
| ### Class E (Intent Alignment) | ||
|
|
||
| - **Link:** [https://github.com/ImmortalDemonGod/flashcore/blob/bd7cdab/.taskmaster/tasks/task_009.md](https://github.com/ImmortalDemonGod/flashcore/blob/bd7cdab/.taskmaster/tasks/task_009.md) | ||
| - **Requirements Verified:** Task 9.2: Document project conventions and workflow constraints | ||
|
|
||
| ### Class B (Referential Evidence) | ||
|
|
||
| **Scope Inventory** (SHA: [`d25cfda`](https://github.com/ImmortalDemonGod/flashcore/tree/d25cfda8b26e5db7b9daccd0c08e7adc345a8266)) | ||
|
|
||
| - [`CLAUDE.md#L1-L164`](https://github.com/ImmortalDemonGod/flashcore/blob/d25cfda8b26e5db7b9daccd0c08e7adc345a8266/CLAUDE.md#L1-L164) | ||
|
|
||
| ### Class A (Execution Evidence) | ||
|
|
||
| - Local checks skipped (--skip-checks). | ||
| - **Skip reason:** New documentation file; no logic change. | ||
|
|
||
|
|
||
| --- | ||
|
|
||
| ## Verification Methodology | ||
|
|
||
| **R0 (trivial) -- local checks skipped.** | ||
| **Reason:** New documentation file; no logic change. | ||
| Only git diff scope inventory was collected. No execution evidence. | ||
|
|
||
| --- | ||
|
|
||
| ## Summary | ||
|
|
||
| Add CLAUDE.md so AI assistant sessions start with full project context |
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,63 @@ | ||
| # AIV Evidence File (v1.0) | ||
|
|
||
| **File:** `README.md` | ||
| **Commit:** `7e2cf5d` | ||
| **Previous:** `6e096b8` | ||
| **Generated:** 2026-03-28T02:24:44Z | ||
| **Protocol:** AIV v2.0 + Addendum 2.7 (Zero-Touch Mandate) | ||
|
|
||
| --- | ||
|
|
||
| ## Classification (required) | ||
|
|
||
| ```yaml | ||
| classification: | ||
| risk_tier: R0 | ||
| sod_mode: S0 | ||
| critical_surfaces: [] | ||
| blast_radius: "README.md" | ||
| classification_rationale: "Documentation removal only; no executable code" | ||
| classified_by: "Miguel Ingram" | ||
| classified_at: "2026-03-28T02:24:44Z" | ||
| ``` | ||
|
|
||
| ## Claim(s) | ||
|
|
||
| 1. Migration guide section removed — one-time internal concern, not useful to general readers | ||
| 2. Status/component table removed — internal project tracking, not useful to library evaluators | ||
| 3. No existing tests were modified or deleted during this change. | ||
|
|
||
| --- | ||
|
|
||
| ## Evidence | ||
|
|
||
| ### Class E (Intent Alignment) | ||
|
|
||
| - **Link:** [https://github.com/ImmortalDemonGod/flashcore/blob/bd7cdab/.taskmaster/tasks/task_009.md](https://github.com/ImmortalDemonGod/flashcore/blob/bd7cdab/.taskmaster/tasks/task_009.md) | ||
| - **Requirements Verified:** Task 9.2: README should serve external readers, not internal project tracking | ||
|
|
||
| ### Class B (Referential Evidence) | ||
|
|
||
| **Scope Inventory** (SHA: [`7e2cf5d`](https://github.com/ImmortalDemonGod/flashcore/tree/7e2cf5d676cf41ec157850b8240a59147b2fcde2)) | ||
|
|
||
| - [`README.md#L1-L221`](https://github.com/ImmortalDemonGod/flashcore/blob/7e2cf5d676cf41ec157850b8240a59147b2fcde2/README.md#L1-L221) | ||
|
|
||
| ### Class A (Execution Evidence) | ||
|
|
||
| - Local checks skipped (--skip-checks). | ||
| - **Skip reason:** Documentation removal only; no logic change. | ||
|
|
||
|
|
||
| --- | ||
|
|
||
| ## Verification Methodology | ||
|
|
||
| **R0 (trivial) -- local checks skipped.** | ||
| **Reason:** Documentation removal only; no logic change. | ||
| Only git diff scope inventory was collected. No execution evidence. | ||
|
|
||
| --- | ||
|
|
||
| ## Summary | ||
|
|
||
| Strip internal project-management content from README |
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,73 @@ | ||
| # AIV Verification Packet (v2.2) | ||
|
|
||
| ## Identification | ||
|
|
||
| | Field | Value | | ||
| |-------|-------| | ||
| | **Repository** | github.com/ImmortalDemonGod/aiv-protocol | | ||
| | **Change ID** | task-9-readme-cleanup | | ||
| | **Commits** | `1ea3f4f` | | ||
| | **Head SHA** | `1ea3f4f` | | ||
| | **Base SHA** | `7e2cf5d` | | ||
| | **Created** | 2026-03-28T02:24:48Z | | ||
|
|
||
| ## Classification | ||
|
|
||
| ```yaml | ||
| classification: | ||
| risk_tier: R0 | ||
| sod_mode: S0 | ||
| critical_surfaces: [] | ||
| blast_radius: component | ||
| classification_rationale: "R0: pure documentation removal, no executable code modified or added" | ||
| classified_by: "Miguel Ingram" | ||
| classified_at: "2026-03-28T02:24:48Z" | ||
| ``` | ||
|
|
||
| ## Claims | ||
|
|
||
| 1. Migration guide section removed — one-time internal concern, not useful to general readers | ||
| 2. Status/component table removed — internal project tracking, not useful to library evaluators | ||
| 3. No existing tests were modified or deleted during this change. | ||
|
|
||
| --- | ||
|
|
||
| ## Evidence References | ||
|
|
||
| | # | Evidence File | Commit SHA | Classes | | ||
| |---|---------------|------------|---------| | ||
| | 1 | EVIDENCE_README.MD.md | `1ea3f4f` | A, B, E | | ||
|
|
||
|
|
||
|
|
||
| ### Class B (Referential Evidence) | ||
|
|
||
| **Scope Inventory** (from 1 file references across evidence files) | ||
|
|
||
| - `README.md#L1-L221` | ||
|
|
||
| ### Class E (Intent Alignment) | ||
|
|
||
| - https://github.com/ImmortalDemonGod/flashcore/blob/bd7cdab/.taskmaster/tasks/task_009.md | ||
| — Task 9.2: README must document installation, usage, architecture, constraints accurately and serve external readers | ||
|
|
||
| --- | ||
|
|
||
| ## Verification Methodology | ||
|
|
||
| **Zero-Touch Mandate:** Verifier inspects artifacts only. | ||
| Evidence was collected by `aiv commit` during the change lifecycle. | ||
| Packet generated by `aiv close`. | ||
|
|
||
| --- | ||
|
|
||
| ## Known Limitations | ||
|
|
||
| - Evidence references point to Layer 1 evidence files at specific commit SHAs. | ||
| Use `git show <sha>:.github/aiv-evidence/<file>` to retrieve. | ||
|
|
||
| --- | ||
|
|
||
| ## Summary | ||
|
|
||
| Change 'task-9-readme-cleanup': 1 commit(s) across 1 file(s). |
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,118 @@ | ||
| # AIV Verification Packet (v2.2) | ||
|
|
||
| ## Identification | ||
|
|
||
| | Field | Value | | ||
| |-------|-------| | ||
| | **Repository** | github.com/ImmortalDemonGod/aiv-protocol | | ||
| | **Change ID** | task-9-readme-quality | | ||
| | **Commits** | `6e096b8`, `d25cfda`, `0ffef18` | | ||
| | **Head SHA** | `0ffef18` | | ||
| | **Base SHA** | `ed9be5d` | | ||
| | **Created** | 2026-03-28T02:15:18Z | | ||
|
|
||
| ## Classification | ||
|
|
||
| ```yaml | ||
| classification: | ||
| risk_tier: R1 | ||
| sod_mode: S0 | ||
| critical_surfaces: [] | ||
| blast_radius: component | ||
| classification_rationale: "R0/R1 mix: pure documentation and status-tracking changes only. No executable code added or modified." | ||
| classified_by: "Miguel Ingram" | ||
| classified_at: "2026-03-28T02:15:18Z" | ||
| ``` | ||
|
|
||
| ## Claims | ||
|
|
||
| 1. All stale 'in progress' references to CLI and Hub implementation removed | ||
| 2. Status table updated: all 9 tasks complete; SVP cognitive layer correctly noted as still in progress | ||
| 3. Quick Start section added so first-time readers have a working path in under 60 seconds | ||
| 4. Key Features bullet for lightweight runtime now names the excluded packages explicitly | ||
| 5. Security features (secret detection, HTML sanitization) documented in Key Features | ||
| 6. Redundant CLI command block consolidated into a single workflow table | ||
| 7. Architecture section removes stale '(in progress)' qualifier from Hub description | ||
| 8. AIV Case Study section updated: contradictory status bullets replaced with accurate state table | ||
| 9. No existing tests were modified or deleted during this change. | ||
| 10. task_009.md status updated to done; subtasks 9.1, 9.2, 9.3 all marked done | ||
| 11. CLAUDE.md created with full aiv commit workflow, E010 false-positive trap, FILE argument constraints, and architecture reminders | ||
| 12. Loaded automatically by Claude Code at session start — no need to repeat instructions each session | ||
|
|
||
| --- | ||
|
|
||
| ## Evidence References | ||
|
|
||
| | # | Evidence File | Commit SHA | Classes | | ||
| |---|---------------|------------|---------| | ||
| | 1 | EVIDENCE_README.MD.md | `6e096b8` | A, B, E | | ||
| | 2 | EVIDENCE_.TASKMASTER_TASKS_TASK_009.MD.md | `d25cfda` | A, B, E | | ||
| | 3 | EVIDENCE_CLAUDE.MD.md | `0ffef18` | A, B, E | | ||
|
|
||
|
|
||
|
|
||
| ### Class E (Intent Alignment) | ||
|
|
||
| - https://github.com/ImmortalDemonGod/flashcore/blob/bd7cdab/.taskmaster/tasks/task_009.md | ||
| — Task 9.2: README must document installation, usage, architecture, constraints, and migration guide accurately; Task 9.3: verification checklist confirmed all-complete | ||
|
|
||
| --- | ||
|
|
||
| ### Class B (Referential Evidence) | ||
|
|
||
| **Scope Inventory** (from 33 file references across evidence files) | ||
|
|
||
| - `README.md#L8-L12` | ||
| - `README.md#L16` | ||
| - `README.md#L18-L21` | ||
| - `README.md#L23-L24` | ||
| - `README.md#L26-L27` | ||
| - `README.md#L29-L30` | ||
| - `README.md#L32-L34` | ||
| - `README.md#L38` | ||
| - `README.md#L40-L53` | ||
| - `README.md#L55` | ||
| - `README.md#L57` | ||
| - `README.md#L59` | ||
| - `README.md#L61-L67` | ||
| - `README.md#L81` | ||
| - `README.md#L84-L87` | ||
| - `README.md#L92` | ||
| - `README.md#L94-L125` | ||
| - `README.md#L137` | ||
| - `README.md#L145` | ||
| - `README.md#L148` | ||
| - `README.md#L150` | ||
| - `README.md#L155` | ||
| - `README.md#L175-L176` | ||
| - `README.md#L179` | ||
| - `README.md#L184` | ||
| - `README.md#L197-L198` | ||
| - `README.md#L204-L241` | ||
| - `README.md#L243-L245` | ||
| - `README.md#L258` | ||
| - `README.md#L264` | ||
| - `.taskmaster/tasks/task_009.md#L5` | ||
| - `.taskmaster/tasks/task_009.md#L47` | ||
| - `CLAUDE.md#L1-L164` | ||
|
|
||
| --- | ||
|
|
||
| ## Verification Methodology | ||
|
|
||
| **Zero-Touch Mandate:** Verifier inspects artifacts only. | ||
| Evidence was collected by `aiv commit` during the change lifecycle. | ||
| Packet generated by `aiv close`. | ||
|
|
||
| --- | ||
|
|
||
| ## Known Limitations | ||
|
|
||
| - Evidence references point to Layer 1 evidence files at specific commit SHAs. | ||
| Use `git show <sha>:.github/aiv-evidence/<file>` to retrieve. | ||
|
|
||
| --- | ||
|
|
||
| ## Summary | ||
|
|
||
| Change 'task-9-readme-quality': 3 commit(s) across 3 file(s). | ||
Oops, something went wrong.
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.
Incorrect repository name.
The repository field shows
github.com/ImmortalDemonGod/aiv-protocol, but all other references in this PR (evidence files, task links, scope inventory URLs) point toImmortalDemonGod/flashcore. This appears to be a copy-paste error.📝 Proposed fix
📝 Committable suggestion
🤖 Prompt for AI Agents