Skip to content

docs: verify active docs against the code, refresh for 1.5.3 - #253

Merged
danileau merged 2 commits into
mainfrom
docs/refresh-20261112
Nov 12, 2026
Merged

danileau merged 2 commits into
mainfrom
docs/refresh-20261112

Conversation

@danileau

Copy link
Copy Markdown
Owner

Checked every active doc against the code and corrected what had drifted. docs/archive/ and docs/incidents/ are historical records and were left alone, apart from one file moved into the archive.

User-facing (shown in-app at /docs)

  • README: the stack is now SvelteKit 3 / Vite 8 / adapter-node. Removed the dev-stack redis row: the dev compose has no Redis, and the API falls back to in-memory counters.
  • FEATURES:
    • PMOS naming.
    • Per-episode time, duration and note.
    • All four quick-add modes, and private entries.
    • The journal now includes episode notes (1.5.3).
    • Export periods corrected to month / calendar year / two years, listing only periods that hold data.
    • The "Export for doctor" shortcut appears only when there is something to export.
    • Corrected a wrong claim: Settings exports decrypted JSON, not encrypted documents.
    • Admin and Settings lists brought up to date.
    • Dropped the claim that the epilepc bundle can be re-imported.
  • SECURITY_MODEL:
    • Recovery code entropy corrected to ~90 bits; it said ~99, which counts the checksum word. Family code is ~49 bits.
    • Added the offline outbox IndexedDB as a storage location.
    • Made the CSP description precise: hash-pinned inline scripts, wasm-unsafe-eval, Cloudflare insights.
    • Code is now cited by symbol name instead of line ranges, which had drifted. security-doc.test.ts now requires symbol cites and checks that the symbols exist.
  • THIRD-PARTY-NOTICES: requirements.txt sets minimum versions, not pinned ones. The license list was completed against the lockfile and the image's pip metadata; it adds MIT-0, BSD-2, Zlib, PSF-2.0 and MPL/Apache.

Developer

  • ARCHITECTURE:
    • Corrected the ports: the API listens on :5000 inside the Docker network; 5050 is the host port.
    • Container count: four in dev, five in prod.
    • SvelteKit 3 config location and #lib imports.
    • Added missing routes and API endpoints.
  • DEVELOPING:
    • Node 22 in dev, 24 in prod; Python 3.11.18.
    • npm run check now runs svelte-kit sync first.
    • It is an adapter-node build, not a static one.
    • Persona seed scripts are gitignored.
    • Layout tree updated.
  • THREAT_MODEL:
    • Checklist path; trust-diagram hosts.
    • Lockout and rate-limit rows.
    • The XSS row and §5 now disclose the Cloudflare insights script.
    • verify_auth name; resolve-pydeps.sh.
  • components/README: usage and wiring of a dozen components corrected (BottomNav tabs, Modal, BottomSheet, ConfirmDelete, LocaleSelect and others), plus line counts and paths.
  • labels-audit.md: removed drifted "line ~N" references; noted five isCustomItem sites not yet covered by RENDER_SITES.
  • REPAIR_NOTES.md: moved from api/tests/ to docs/archive/REPAIR_NOTES_pi21.md, marked as a historical record. Nothing reads it.

Operations

  • OPERATIONS:
  • INCIDENT_RESPONSE: detection sources, a stopped app gives a 52x and not a 503, hot-patch back-sync, and the Actions secrets to rotate.
  • VERSIONING: the backfill section was stale (v0.1.0 through v1.5.3 are all tagged). Clarified the manual release tag and the enforcement.
  • backlog: reviewed as of 1.5.3; SEO item partly done (fix(seo): give every public page its own title and canonical #235).
  • changelog.d/README: waiver forms; the wizard warns about pending fragments.

Testing

  • vitest: 2250 passed, including the doc guards (docs-*, security-doc, labels-audit-doc, customItems-render, components-inventory).
  • svelte-check: 0/0. Build OK.
  • changelog.mjs check OK. pytest: 276 passed.

@danileau
danileau merged commit c5639b2 into main Nov 12, 2026
4 checks passed
@danileau
danileau deleted the docs/refresh-20261112 branch November 12, 2026 14:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant