Skip to content

Commit 53a7002

Browse files
RobLe3claude
andcommitted
docs: final beautification, archive legacy process, externalize paper reference
- Remove paper/ directory from repository - Update all paper references to https://roblemumin.com/library.html - Add paper/ to .gitignore - Archive historical process docs with status banners: - docs/autostart.md, docs/defaults.md, docs/benchmark_policy.md - docs/manual/part_0.md through part_9.md - Add Maintenance Status section to README - Update Project Structure section in README - Clarify fire-and-forget maintenance model - Update Contributing section scope All 169 tests passing ✓ All non-negotiable constraints preserved ✓ Repository now reflects completed, reference-grade status 🤖 Generated with Claude Code (https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent 67f19b8 commit 53a7002

33 files changed

Lines changed: 149 additions & 46 deletions

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,3 +92,6 @@ Thumbs.db
9292

9393
# Editor artifacts
9494
.editorconfig.bak
95+
96+
# Paper reference (external canonical)
97+
paper/

README.md

Lines changed: 40 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ LULZprime inherits from the OMPC approach:
152152

153153
This reframes primes from a brute-force enumeration problem into a navigable space.
154154

155-
**Canonical reference**: `paper/OMPC_v1.33.7lulz.pdf`
155+
**Canonical reference**: [OMPC Paper at roblemumin.com](https://roblemumin.com/library.html)
156156

157157
## Documentation
158158

@@ -162,7 +162,35 @@ This reframes primes from a brute-force enumeration problem into a navigable spa
162162
- **API contracts**: `docs/manual/part_4.md`
163163
- **Workflows**: `docs/manual/part_5.md`
164164
- **Developer guide**: `docs/autostart.md` and `docs/defaults.md`
165-
- **Canonical paper**: `paper/OMPC_v1.33.7lulz.pdf`
165+
- **Canonical paper**: [OMPC at roblemumin.com](https://roblemumin.com/library.html)
166+
167+
**Note:** Documentation in `docs/manual/`, `docs/autostart.md`, `docs/defaults.md`, and `docs/benchmark_policy.md` reflects historical development process and is archived. The project is now a completed, reference-grade implementation.
168+
169+
## Maintenance Status
170+
171+
**Current Status:** Completed reference implementation (v0.1.0)
172+
173+
LULZprime is a **finished artifact**. The implementation has achieved full paper alignment and is production-ready for indices up to 500k.
174+
175+
**Maintenance model:**
176+
- **Bug fixes:** Critical bugs will be addressed
177+
- **Security issues:** Reported vulnerabilities will be fixed
178+
- **No active feature development:** The library is feature-complete for its intended scope
179+
- **No performance tuning:** Python implementation is at optimum (Phase 3 validated)
180+
- **Community contributions:** Bug fixes and documentation improvements welcome (see CONTRIBUTING.md)
181+
182+
**What this means:**
183+
- The library is stable and safe to use in production
184+
- API will not change (backward compatibility preserved)
185+
- No new features planned (scope is deliberately limited)
186+
- All 169 tests continue to pass
187+
- Defaults remain unchanged (ENABLE_LEHMER_PI = False)
188+
189+
**Future work (out of scope):**
190+
- C/Rust port for paper-exceedance performance (10-50× gains possible)
191+
- P3 correction or Deleglise-Rivat algorithms (research-level)
192+
193+
See `docs/PAPER_EXCEEDANCE_ROADMAP.md` for potential future directions (informational only).
166194

167195
## How to Support
168196

@@ -198,26 +226,22 @@ pytest --cov=src/lulzprime --cov-report=html
198226

199227
```
200228
lulzprime/
201-
├── src/lulzprime/ # Source code
202-
├── tests/ # Test suite (169 tests)
203-
├── docs/ # Documentation
204-
│ ├── manual/ # Development manual (Parts 0-9)
229+
├── src/lulzprime/ # Core deterministic implementation
230+
├── tests/ # Test suite (169 tests, all passing)
231+
├── docs/ # Design decisions, validation, release notes
205232
│ ├── adr/ # Architecture Decision Records
233+
│ ├── manual/ # Development manual (historical, archived)
206234
│ ├── PAPER_ALIGNMENT_STATUS.md # Performance validation
207-
│ └── FINAL_SUMMARY.md # Phase 0-6 completion summary
208-
├── paper/ # Canonical OMPC paper
209-
├── experiments/ # Validation experiments
210-
└── benchmarks/ # Performance benchmarks
235+
│ └── RELEASE_CHECKLIST.md # PyPI release workflow
236+
├── benchmarks/ # Manual benchmarks (not run in CI)
237+
└── experiments/ # One-off validation scripts
211238
```
212239

213240
### Contributing
214241

215242
See `CONTRIBUTING.md` for contribution guidelines.
216243

217-
**Important**: Before contributing, read:
218-
1. `docs/autostart.md` - Startup procedure and parse order
219-
2. `docs/defaults.md` - Repository rules and constraints
220-
3. `docs/manual/part_0.md` through `part_9.md` - Development manual
244+
**Scope:** Bug fixes and documentation improvements are welcome. New features or algorithm changes are out of scope (library is feature-complete).
221245

222246
## Non-Goals
223247

@@ -235,10 +259,8 @@ MIT License - See `LICENSE` file for details.
235259

236260
## Citation
237261

238-
If you use LULZprime in academic work, please cite the canonical OMPC paper:
239-
```
240-
[Citation details from paper/OMPC_v1.33.7lulz.pdf]
241-
```
262+
If you use LULZprime in academic work, please cite the canonical OMPC paper available at:
263+
https://roblemumin.com/library.html
242264

243265
## Support & Issues
244266

docs/PAPER_ALIGNMENT_STATUS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
**Date:** 2025-12-18
44
**Implementation:** Meissel-Lehmer with P2 correction (Phases 1-4 complete)
5-
**Reference:** paper/OMPC_v1.33.7lulz.pdf
5+
**Reference:** [OMPC Paper](https://roblemumin.com/library.html)
66

77
---
88

docs/adr/0002-memory-bounded-pi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -388,7 +388,7 @@ Add to docs/todo.md as future work with:
388388
- **Constraints:** docs/manual/part_2.md (section 2.5), docs/manual/part_6.md (sections 6.3, 6.4)
389389
- **Workflow:** docs/manual/part_5.md (section 5.3)
390390
- **Goals:** docs/manual/part_9.md (G2 Hardware Efficiency, G7 OMPC Alignment)
391-
- **Canonical Reference:** paper/OMPC_v1.33.7lulz.pdf
391+
- **Canonical Reference:** https://roblemumin.com/library.html
392392

393393
---
394394

docs/adr/0004-parallel-pi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -410,7 +410,7 @@ LOW (builds on Option B with simple threshold check)
410410
- **ADR 0002:** docs/adr/0002-memory-bounded-pi.md (memory-bounded π(x) implementation)
411411
- **Constraints:** docs/manual/part_6.md (section 6.3 sublinear target, section 6.4 memory)
412412
- **API Contract:** docs/api_contract.md (performance expectations)
413-
- **Canonical Reference:** paper/OMPC_v1.33.7lulz.pdf
413+
- **Canonical Reference:** https://roblemumin.com/library.html
414414

415415
---
416416

docs/adr/0005-lehmer-pi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -470,7 +470,7 @@ def pi(x: int) -> int:
470470
- **ADR 0002:** Memory-bounded π(x) (segmented sieve baseline)
471471
- **ADR 0004:** Parallel π(x) (multiprocessing, not algorithmic)
472472
- **Part 6 section 6.3:** Sublinear π(x) target specification
473-
- **Canonical Reference:** paper/OMPC_v1.33.7lulz.pdf
473+
- **Canonical Reference:** https://roblemumin.com/library.html
474474

475475
---
476476

docs/api_contract.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ It serves as the canonical reference for:
1515
- Misuse cases that users must avoid
1616

1717
**Canonical references:**
18-
- `paper/OMPC_v1.33.7lulz.pdf` (conceptual foundation)
18+
- [OMPC Paper](https://roblemumin.com/library.html) (conceptual foundation)
1919
- `docs/manual/part_4.md` (API specification)
2020
- `docs/manual/part_9.md` (alignment goals)
2121

@@ -506,7 +506,7 @@ primes = resolve_many_parallel([100_000, 200_000, 300_000], workers=4)
506506

507507
## References
508508

509-
- **Canonical paper**: paper/OMPC_v1.33.7lulz.pdf
509+
- **Canonical paper**: [OMPC at roblemumin.com](https://roblemumin.com/library.html)
510510
- **Public API spec**: docs/manual/part_4.md
511511
- **Workflows**: docs/manual/part_5.md
512512
- **Performance constraints**: docs/manual/part_6.md

docs/autostart.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
# autostart.md
1+
> ⚠️ **Status: Historical / Archived**
2+
>
3+
> This document reflects the development process used while LULZprime was actively evolving.
4+
> The project is now a completed, reference-grade implementation.
5+
> This file is retained for context and provenance only.
6+
7+
# autostart.md
28
**LULZprime – Agent / Developer Startup Order, Consultation Priority, and Tracking Files**
39

410
---
@@ -23,7 +29,7 @@ This file is a **runbook**, the first operational entry point after cloning the
2329

2430
When there is any conflict or uncertainty, resolve by consulting sources in this order:
2531

26-
1. `paper/OMPC_v1.33.7lulz.pdf`
32+
1. `https://roblemumin.com/library.html`
2733
2. `docs/manual/part_0.md``docs/manual/part_9.md`
2834
3. `docs/defaults.md`
2935
4. Source code under `src/lulzprime/`
@@ -108,7 +114,7 @@ Then proceed into code changes.
108114

109115
When an agent or developer is uncertain about correctness, scope, or intent:
110116

111-
1. Consult `paper/OMPC_v1.33.7lulz.pdf`
117+
1. Consult `https://roblemumin.com/library.html`
112118
2. Consult `docs/manual/part_0.md` (concept primer)
113119
3. Consult `docs/manual/part_2.md` (constraints)
114120
4. Consult `docs/manual/part_4.md` (API contract)
@@ -188,7 +194,7 @@ Then ensure it remains optional and does not couple into core.
188194

189195
### 7.4 Before any change to resolver workflow
190196
Read:
191-
- `paper/OMPC_v1.33.7lulz.pdf`
197+
- `https://roblemumin.com/library.html`
192198
- `docs/manual/part_5.md`
193199
- `docs/manual/part_7.md`
194200
Any workflow change must be logged as `WORKFLOW-CHANGE` in `docs/issues.md`.
@@ -211,7 +217,7 @@ At the end of any work session:
211217
## 9. File Locations (Single Source of Truth)
212218

213219
- Canonical paper:
214-
`paper/OMPC_v1.33.7lulz.pdf`
220+
`https://roblemumin.com/library.html`
215221

216222
- Manual:
217223
`docs/manual/part_0.md``docs/manual/part_9.md`

docs/benchmark_policy.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
> ⚠️ **Status: Historical / Archived**
2+
>
3+
> This document reflects the development process used while LULZprime was actively evolving.
4+
> The project is now a completed, reference-grade implementation.
5+
> This file is retained for context and provenance only.
6+
17
# Benchmark Policy
28

39
**LULZprime – Benchmark Execution Rules and Time Caps**

docs/defaults.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
# defaults.md
1+
> ⚠️ **Status: Historical / Archived**
2+
>
3+
> This document reflects the development process used while LULZprime was actively evolving.
4+
> The project is now a completed, reference-grade implementation.
5+
> This file is retained for context and provenance only.
6+
7+
# defaults.md
28
**LULZprime – Development Defaults, Repository Scaffold, and Operational Rules**
39

410
---
@@ -23,11 +29,11 @@ This document is **binding**, not advisory.
2329
## 1. Canonical References and Precedence
2430

2531
### 1.1 Canonical concept source
26-
- **Primary reference:** `paper/OMPC_v1.33.7lulz.pdf`
32+
- **Primary reference:** `https://roblemumin.com/library.html`
2733
- **Rule:** *If in doubt, check the paper.*
2834

2935
### 1.2 Precedence order (highest to lowest)
30-
1. `paper/OMPC_v1.33.7lulz.pdf`
36+
1. `https://roblemumin.com/library.html`
3137
2. `docs/manual/part_0.md` through `part_9.md`
3238
3. `docs/defaults.md` (this file)
3339
4. Source code
@@ -113,7 +119,7 @@ The project favors **explicit ignores over accidental leaks**.
113119
- Each part is versioned, short, and scoped.
114120

115121
### 6.2 Canonical paper
116-
- `paper/OMPC_v1.33.7lulz.pdf` must exist in the repo.
122+
- `https://roblemumin.com/library.html` must exist in the repo.
117123
- Long verbatim excerpts must **not** be copied into docs.
118124
- Docs may summarize and reference, not reproduce.
119125

0 commit comments

Comments
 (0)