Skip to content

Commit f969bd6

Browse files
hyperpolymathclaude
hyperpolymath
and
claude
committed
refactor(docs): reorganise root into proper RSR directory structure
Root had 40+ files including stale migration guides, an arXiv paper, dead configs (vitest.config.js), and a 960-line Sonnet task list from February. The docs/ directory was a flat dump of 17 files with no structure. Deleted: - vitest.config.js (dead — migrated to Deno.test) - SONNET-TASKS.md (completed Feb audit — work is done) Reorganised docs/ into: - architecture/ — TOPOLOGY.md, ARCHITECTURE.md/.txt, panel inventory - decisions/ — DD-001 to DD-018 + eNSAID spec - design/ — dated session design documents - guides/ — quick starts, TEA guide, testing, LLM warmup - status/ — completion reports and audits - archive/ — completed migration guides (ReScript-TEA, npm-to-Deno) - research/ — Binary Star arXiv paper (1614 lines) with build README Created: - docs/ENSAID.adoc — first-class home for eNSAID philosophy, Binary Star model, cognitive governance, TypeLL, formal definition - docs/README.adoc — navigation index for docs hierarchy Updated: - README.adoc — full documentation section with links to new locations - .gitignore — deduplicated, added *.cmt/*.cmti/*.cmi Root now has 18 files (down from 40+), all essential. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent da42e54 commit f969bd6

35 files changed

Lines changed: 325 additions & 876 deletions

‎.gitignore‎

Lines changed: 57 additions & 102 deletions
Original file line numberDiff line numberDiff line change
@@ -1,169 +1,124 @@
11
# RSR-compliant .gitignore
22
# SPDX-License-Identifier: PMPL-1.0-or-later
33

4-
# Node + package managers
4+
# ── Node + package managers ──────────────────────────────
55
node_modules/
66
.pnpm-store/
77

8-
# Deno
8+
# ── Deno ─────────────────────────────────────────────────
99
.deno/
1010

11-
# ReScript generated output (in-source mode)
11+
# ── ReScript (in-source mode) ────────────────────────────
1212
lib/
13+
lib/bs/
1314
.merlin
15+
.bsb.lock
1416
*.res.js
1517
*.resi.js
18+
*.cmt
19+
*.cmti
20+
*.cmi
1621

17-
# Tauri build artifacts
22+
# ── Rust / Gossamer ──────────────────────────────────────
23+
/target/
24+
src-gossamer/target/
1825
src-tauri/target/
1926
src-tauri/WixTools/
2027
src-tauri/Cargo.lock
28+
/zig-out/
29+
/zig-cache/
2130

22-
# BEAM/Elixir build artifacts
31+
# ── BEAM / Elixir ───────────────────────────────────────
32+
/_build/
2333
beam/**/_build/
2434
beam/**/deps/
2535
beam/**/.elixir_ls/
2636
beam/**/erl_crash.dump
37+
/.elixir_ls/
38+
/cover/
39+
/doc/
40+
*.ez
41+
erl_crash.dump
2742

28-
# Frontend build artifacts
43+
# ── Frontend build artifacts ─────────────────────────────
2944
public/styles.css
3045
public/app.bundle.js
3146
public/app.bundle.js.map
3247
dist/
3348
build/
34-
coverage/
49+
out/
3550

36-
# Local panic-attacker / PanLL integration artifacts
51+
# ── PanLL integration artifacts ─────────────────────────
3752
panic-attack-*.json
3853
panll-event-chain-*.json
3954
*.ctp
40-
41-
# Logs and temporary files
42-
*.log
43-
npm-debug.log*
44-
*.swp
45-
*.swo
46-
*~
47-
48-
# Environment files
49-
.env
50-
.env.local
51-
.env.*.local
52-
runtime/.env
53-
runtime/.env.*
54-
55-
# Hypatia scanning artifacts
56-
.hypatia/
57-
58-
# PanLL local state (session storage, feedback logs)
5955
.panll/
6056

61-
# Playwright test artifacts
57+
# ── Test / Coverage ─────────────────────────────────────
58+
coverage/
6259
test-results/
6360
playwright-report/
61+
htmlcov/
6462

65-
# IDE and OS files
66-
.idea/
67-
.vscode/
68-
.DS_Store
69-
Thumbs.db
70-
*.kate-swp
71-
72-
73-
# OS & Editor
74-
.DS_Store
75-
Thumbs.db
76-
*.swp
77-
*.swo
78-
*~
79-
.idea/
80-
.vscode/
81-
82-
83-
# Build
84-
/target/
85-
/_build/
86-
/build/
87-
/dist/
88-
/out/
89-
/zig-out/
90-
/zig-cache/
91-
92-
93-
# Dependencies
94-
/node_modules/
95-
/vendor/
96-
/deps/
97-
/.elixir_ls/
98-
99-
100-
# Rust
101-
102-
# Cargo.lock # Keep for binaries
103-
104-
105-
# Elixir
106-
/cover/
107-
/doc/
108-
*.ez
109-
erl_crash.dump
110-
111-
112-
# Julia
63+
# ── Julia ────────────────────────────────────────────────
11364
*.jl.cov
11465
*.jl.mem
11566
/Manifest.toml
11667

117-
118-
# ReScript
119-
/lib/bs/
120-
/.bsb.lock
121-
122-
123-
# Python (SaltStack only)
68+
# ── Python (SaltStack only) ─────────────────────────────
12469
__pycache__/
12570
*.py[cod]
12671
.venv/
12772

128-
129-
# Ada/SPARK
73+
# ── Ada / SPARK ──────────────────────────────────────────
13074
*.ali
13175
/obj/
13276
/bin/
13377

134-
135-
# Haskell
78+
# ── Haskell ──────────────────────────────────────────────
13679
/.stack-work/
13780
/dist-newstyle/
13881

139-
140-
# Chapel
82+
# ── Chapel ───────────────────────────────────────────────
14183
*.chpl.tmp.*
14284

143-
144-
# Secrets
85+
# ── Secrets ──────────────────────────────────────────────
14586
.env
14687
.env.*
88+
.env.local
89+
.env.*.local
90+
runtime/.env
91+
runtime/.env.*
14792
*.pem
14893
*.key
14994
secrets/
15095

151-
152-
# Test/Coverage
153-
/coverage/
154-
htmlcov/
155-
156-
157-
# Logs
96+
# ── Logs ─────────────────────────────────────────────────
15897
*.log
98+
npm-debug.log*
15999
/logs/
160100

101+
# ── OS & Editor ─────────────────────────────────────────
102+
.DS_Store
103+
Thumbs.db
104+
*.swp
105+
*.swo
106+
*~
107+
*.kate-swp
108+
.idea/
109+
.vscode/
161110

162-
# Machine-readable locks
163-
.machine_readable/.locks/
111+
# ── Hypatia scanning artifacts ──────────────────────────
112+
.hypatia/
164113

114+
# ── Machine-readable locks ──────────────────────────────
115+
.machine_readable/.locks/
165116

166-
# Temp
117+
# ── Temp ─────────────────────────────────────────────────
167118
/tmp/
168119
*.tmp
169-
*.bak
120+
*.bak
121+
122+
# ── Dependencies ────────────────────────────────────────
123+
/vendor/
124+
/deps/

‎README.adoc‎

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,33 @@ deno task dev
121121

122122
== Documentation
123123

124-
* **link:docs/TEA_GUIDE.md[TEA Architecture Guide]** — Comprehensive documentation for The Elm Architecture (TEA) implementation including Tea_Cmd, Tea_Sub, Tea_Vdom, and Tea_App modules with testing guide and best practices
124+
=== Philosophy & Design
125+
126+
* **link:docs/ENSAID.adoc[eNSAID Specification]** — The Binary Star model, cognitive governance, and what makes PanLL different from every other IDE
127+
* **link:docs/decisions/PANLL-ENSAID-SPEC-AND-DESIGN-DECISIONS.md[Design Decisions (DD-001 to DD-018)]** — Every architectural decision with context, rationale, and consequences
128+
* **link:docs/research/binary-star-neurosymbolic-ide.tex[Binary Star Paper]** — Full academic paper formalising the neurosymbolic co-orbit model (arXiv draft)
129+
130+
=== Architecture
131+
132+
* **link:docs/architecture/TOPOLOGY.md[Topology]** — System architecture map and completion dashboard
133+
* **link:docs/architecture/ARCHITECTURE.md[Architecture Reference]** — TEA modules, engine pattern, clade system, BoJ gateway, cognitive governance
134+
* **link:docs/architecture/ARCHITECTURE.txt[System Diagrams]** — ASCII-art architecture diagrams (frontend, Pane-N, data flow, trust hierarchy)
135+
* **link:docs/architecture/PANEL-INVENTORY.md[Panel Inventory]** — Complete inventory of all panels
136+
137+
=== Guides
138+
139+
* **link:docs/guides/TEA_GUIDE.md[TEA Architecture Guide]** — The Elm Architecture implementation: Tea_Cmd, Tea_Sub, Tea_Vdom, Tea_App
140+
* **link:docs/guides/QUICKSTART-USER.adoc[Quick Start (Users)]** — Getting started with PanLL
141+
* **link:docs/guides/QUICKSTART-FOR-SON.md[Quick Start (Developers)]** — Developer-focused onboarding
142+
* **link:docs/guides/TESTING.md[Testing Guide]** — Test strategy and conventions
143+
* **link:docs/guides/llm-warmup-dev.md[LLM Warmup (Dev)]** — Context for AI-assisted development
144+
* **link:docs/guides/llm-warmup-user.md[LLM Warmup (User)]** — User-facing LLM context
145+
146+
=== Planning
147+
148+
* **link:docs/ROADMAP.adoc[Roadmap]** — Version-by-version feature plan (v0.2.0 through v1.0.0)
149+
* **link:docs/TODO.md[TODO]** — Active task list with triaxial scoring
150+
* **link:docs/EXPLAINME.adoc[EXPLAINME]** — Backs up README claims for sceptics
125151

126152
== Event-Chain Import (panic-attack)
127153

@@ -193,4 +219,4 @@ PMPL-1.0-or-later
193219

194220
== Architecture
195221

196-
See link:TOPOLOGY.md[TOPOLOGY.md] for a visual architecture map and completion dashboard.
222+
See link:docs/architecture/TOPOLOGY.md[TOPOLOGY.md] for a visual architecture map and completion dashboard.

0 commit comments

Comments
 (0)