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
2 changes: 1 addition & 1 deletion .please/INDEX.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
| `docs/decisions/` | Architecture Decision Records → [Decisions Index](docs/decisions/index.md) |
| `docs/investigations/` | Bug investigation reports |
| `docs/research/` | Research documents |
| `docs/references/` | External reference materials (-llms.txt etc.) |
| `docs/references/` | External reference materials & upstream analyses → [References Index](docs/references/index.md) |
| `docs/knowledge/` | Stable project context (product, tech-stack, guidelines, workflow) |
| `templates/` | Workflow templates (plugin-provided) |
| `scripts/` | Utility scripts (plugin-provided) |
Expand Down
35 changes: 35 additions & 0 deletions .please/docs/references/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Reference Analyses

> Deep-dive analyses of the external libraries `@pleaseai/csp` ports from or draws on.
> Each document maps an upstream codebase module-by-module to its csp counterpart,
> records the load-bearing algorithms and parameters, and tracks where the csp port
> intentionally (or accidentally) diverges from upstream.

These are **reference materials**, not contracts. The contract is `README.md` / `ARCHITECTURE.md`.
When upstream moves, update the relevant analysis here and reconcile any new drift against
[the sync baseline](#sync-baselines).

## Documents

| Library | Upstream | Role | Analysis |
|---|---|---|---|
| **semble** | [MinishLab/semble](https://github.com/MinishLab/semble) | Direct port source — analyzed against the **Rust port** (`crates/csp`, [ADR-0003](../decisions/0003-rewrite-in-rust.md)) | [semble.md](semble.md) |

<!-- Add new reference analyses above this line as additional libraries are adopted. -->

## Sync baselines

Each analysis records the exact upstream commit it was written against. To check for upstream
drift, diff from that commit forward (`git log <baseline>..main` in the upstream checkout).

| Library | Analyzed at | Notes |
|---|---|---|
| semble | upstream `136b6f7` (2026-06-18); Rust port `2f2baa2` (PR #34) | Mapped to the Rust crates; beyond prior review baseline `eacbe43`; see semble.md §Divergences |

## How to add a new reference analysis

1. Create `.please/docs/references/<library>.md` following the structure of `semble.md`:
overview → pipeline → module map → per-module deep dives → key algorithms → divergences.
2. Pin the exact upstream commit analyzed (record it in the **Sync baselines** table above).
3. Map every upstream module to its csp counterpart (or mark it *not ported* / *adapted*).
4. Add a row to the **Documents** table and link the new file.
Loading
Loading