Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
57 commits
Select commit Hold shift + click to select a range
27b36f6
Stabilizer subsystem rebuild: Phases 1-4 + Quiet cleanup
mbahram May 1, 2026
222122c
Stabilizer Phase 5a: GraphState + LocalComplement (AndBri05)
mbahram May 1, 2026
4262b6f
Stabilizer Phase 5b: synthesis-implementation companion document
mbahram May 1, 2026
d5ee3bf
Stabilizer ROADMAP: consolidated tracker for partial/deferred/buggy i…
mbahram May 1, 2026
1789963
Stabilizer API.md: per-function reference with verified code
mbahram May 1, 2026
9b3b1ec
Add QSVT notebook, audit notes, and image
mbahram May 1, 2026
86ca2a6
Move Stabilizer audit + docs to OngoingProjects/Stabilizer/
mbahram May 2, 2026
f590a8f
Remove old Documentation/Stabilizer/ stubs (moved to OngoingProjects/…
mbahram May 2, 2026
93edc40
Stabilizer Phase 5c (red): TIER 1.4a/1.4b/1.4c roundtrip tests
mbahram May 4, 2026
6f8637e
Stabilizer Phase 5c step 2: fix QuantumState->PauliStabilizer sign loss
mbahram May 4, 2026
f7ebfd5
Stabilizer Phase 5c step 3: fix QuantumOperator->PauliStabilizer phas…
mbahram May 4, 2026
57d8b53
Stabilizer Phase 5c docs: ROADMAP + API + synthesis-implementation
mbahram May 4, 2026
f9e2d71
Stabilizer Phase 5c follow-up: post-mortem, A.9 contract, TIER 1.4d
mbahram May 4, 2026
cbf5157
Stabilizer Phase 5c follow-up: cross-module roundtrip audit (Tests/Ro…
mbahram May 4, 2026
cb04344
Stabilizer Phase 5c: ROADMAP + post-mortem updates (A.9 reclassified)
mbahram May 4, 2026
070eb33
Stabilizer verify-API.wls: reorder blocks to match API.md doc order
mbahram May 4, 2026
3e0539f
Stabilizer API.md: document GlobalPhase + round-trip contract (Phase 5c)
mbahram May 4, 2026
90639b6
Stabilizer TIER 1.4e: coverage matrix for PauliStabilizer accessors
mbahram May 4, 2026
abc51f3
Stabilizer: rewrite 1.1-multiplication-via-symplectic + embed in MD
mbahram May 4, 2026
20bddd3
ROADMAP: record Phase 5c follow-ups & tests
mbahram May 5, 2026
4807259
Stabilizer: 10 reference pages for Stabilizer subsystem public exports
mbahram May 5, 2026
dc2f5ae
Stabilizer: move 10 reference page drafts out of live docs tree
mbahram May 5, 2026
2a704d0
Stabilizer docs: mark source-audit historical; replace stale TODOs wi…
mbahram May 5, 2026
b7f0b1b
Stabilizer Phase 6: API consolidation (10 -> 6 public symbols)
mbahram May 6, 2026
091f1a8
Stabilizer Phase 6.5: demote InnerProduct + Expectation (6 -> 4 publi…
mbahram May 6, 2026
1cb966a
Stabilizer Phase 7.1: hybrid interop UpValues with Pauli-basis fast path
mbahram May 6, 2026
7171505
Stabilizer Phase 7.2: route named Pauli channels through tableau
mbahram May 6, 2026
f5b6656
Stabilizer Phase 8.1: CliffordChannel head per Yashin25 (scaffolding)
mbahram May 6, 2026
44e7509
Stabilizer Phases 7+8: expand test coverage (+28 tests)
mbahram May 7, 2026
51b931f
Stabilizer: add textbook-correctness + Stim + QuantumClifford.jl cros…
mbahram May 7, 2026
032586b
Stabilizer Phases 7.3 + 8.2: extended Pauli detection + Choi-tableau …
mbahram May 7, 2026
363d727
Stabilizer Phases 7.4 + 8.3: matrix-iteration Pauli detector + AG pha…
mbahram May 7, 2026
e7526f8
Stabilizer WL-idiom audit + AuditMatrix.wlt + Tests reorganized into …
mbahram May 7, 2026
6f74fd4
Stabilizer Documentation/: rewrite API.md, retire synthesis-implement…
mbahram May 7, 2026
08f3cd2
Stabilizer Documentation/: rename to lowercase + complete api.md audit
mbahram May 7, 2026
2fb4e82
Stabilizer: add Tests/Stabilizer/Connections.wlt + correct api.md dis…
mbahram May 7, 2026
7bafb4a
Stabilizer Phase 8.4: convert ineffective DownValues to UpValues so Q…
mbahram May 7, 2026
9c7b218
Stabilizer A-series: resolve A.1, A.2, A.3, A.11, A.12, A.13
mbahram May 7, 2026
cf5f09a
Stabilizer A-series: resolve A.4 (deterministic-outcome stamping) + A…
mbahram May 7, 2026
8b93625
Stabilizer A-series: resolve A.8 (StabilizerStateQ public symbol) + A…
mbahram May 7, 2026
5e242ab
Stabilizer roadmap: A-series sweep status (10 / 13 closed, 3 scoped f…
mbahram May 7, 2026
40ee1f1
Add stabilizer formula test suite and reports
mbahram May 7, 2026
66ad1b3
Stabilizer: fix named-code logical operators (P1, F1)
mbahram May 8, 2026
c2239dd
Stabilizer: fix Pauli-string measurement post-state on random outcome…
mbahram May 8, 2026
3bc7fcd
Stabilizer: route CliffordChannel state-prep dispatch (nA == 0) to ta…
mbahram May 8, 2026
609e027
Stabilizer: integrate Formula_Test battery into main runner + record …
mbahram May 8, 2026
1002e16
Add Suzuki-Trotter implementation and tests
mbahram May 8, 2026
8dc5b3f
Merge origin/main into stabilizer-phases-1-4
mbahram May 8, 2026
f643db3
Add Trotterization docs and fix tests
mbahram May 8, 2026
cad2678
more closed-form formula and tests
mbahram May 8, 2026
8b83e62
Stabilizer: documentation and kernel updates
mbahram May 10, 2026
38c0a44
Add builder script for PauliStabilizer docs
mbahram May 11, 2026
b466909
Add stabilizer doc builders; update docs & kernel
mbahram May 11, 2026
15c2ccd
fix QuantumState.nb doc tables and math typography
mbahram May 11, 2026
e04c6a1
Add QF paclet-doc-rewrite-template usage
mbahram May 11, 2026
841f9f0
Improve stabilizer error handling
mbahram May 13, 2026
4b13edc
Stabilizer: tidy comments and remove deprecation
mbahram May 14, 2026
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Using `paclet-doc-rewrite-template` for QuantumFramework doc rewrites

> Project-local cheat-sheet. For the full methodology, read the canonical template directly: [`~/.claude/prompts/paclet-doc-rewrite-template.md`](file:///Users/mohammadb/.claude/prompts/paclet-doc-rewrite-template.md).

## What this directory is

`OngoingProjects/Improving doc pages/` tracks ongoing work to clean up QuantumFramework's reference doc pages. The workflow is driven by the canonical template at `~/.claude/prompts/paclet-doc-rewrite-template.md` (paclet-agnostic, ~620 lines, 5 API regimes + bootstrap mode).

## Invoking for a QF page (the QF shortcut)

In a fresh Claude Code session, paste:

```
Use the template at ~/.claude/prompts/paclet-doc-rewrite-template.md.
Paclet config: use the QuantumFramework defaults from Appendix C.
<SYMBOL> = QuantumOperator (the symbol to document)
<SIBLING_PAGE> = QuantumState.nb (or a closer cousin once it exists)
<PARENT> = QuantumBasis (look up in Appendix C parent-class map)
<SYMBOL-area> = QuantumState (kernel subdirectory)
Begin with Checkpoint 0.
```

The template reads Appendix C for QuantumFramework paclet-config and runs the 4-checkpoint workflow.

## What's done · what's next

| Symbol | Status | Notes |
|---|---|---|
| `QuantumState` | Partial — surgical edits applied (Options ExampleSection removed, XXXX placeholders cleared), spec for full rewrite locked in conversation history. Full mechanical rewrite handed off to a spawned task. | Backup at `QuantumState.nb.bak.20260510-182845` |
| `QuantumOperator`, `QuantumChannel`, `QuantumMeasurementOperator`, `QuantumCircuitOperator`, `QuantumEvolve`, others | Not started | Use the template; once `QuantumState.nb` is done, it becomes the `<SIBLING_PAGE>` for the rest |

## QF-specific quick references

| Item | Value |
|---|---|
| Paclet root | `/Users/mohammadb/Documents/GitHub/QuantumFramework/QuantumFramework` |
| Docs dir | `<PACLET_ROOT>/Documentation/English/ReferencePages/Symbols` |
| Tests | `wolframscript -f Tests/RunTests.wls Stabilizer` |
| Regression baseline | `main@HEAD`; one pre-existing failure (`Phase2-PauliStabilizer-UsageMessage`) is unrelated to doc work |
| Empty-placeholder convention | `"XXXX"` (verified) |
| Most QF symbols | Regime (a) property-dispatch — except `QuantumEvolve` (regime b) and `QuantumCircuitOperator` (regime c) |

## When the canonical template needs updating

If you discover a new edge case during a rewrite (e.g. a sixth regime, a new kernel-source convention, a category-design rule that doesn't generalize), edit the canonical template at `~/.claude/prompts/paclet-doc-rewrite-template.md`. The QF shim at `~/.claude/prompts/qf-doc-rewrite-template.md` is a thin redirector — don't put new content there.

## Related files

- [Canonical template](file:///Users/mohammadb/.claude/prompts/paclet-doc-rewrite-template.md) — 620 lines, paclet-agnostic.
- [QF shim](file:///Users/mohammadb/.claude/prompts/qf-doc-rewrite-template.md) — 39-line redirect to the canonical, for muscle-memory continuity.
- [Pre-generalization backup](file:///Users/mohammadb/.claude/prompts/qf-doc-rewrite-template.md.bak.20260511-110943) — historical reference.
- `Doc writing skill Claude/` (sibling subdir) — older notes from the doc-improvement project, predates the canonical template.
- `per-function-runbook.md` (sibling file) — older per-function runbook, predates the canonical template.
Loading
Loading