Skip to content

DOC_README

github-actions[bot] edited this page Apr 11, 2026 · 47 revisions

AI Assistant Context

All project documentation lives in design_docs/.

DOC_README Authority

DOC_README.md is the authoritative first-reference document for documentation state.

It serves three goals:

  1. Capture AI-agent insights and convert durable notes into Working Principles.
  2. Provide the sole canonical index for active design_docs documentation and current project guidance.
  3. Stay synchronized with current design_docs/ contents and reflect the latest active documentation state.

Required Reading Order

  1. DOC_README.md
  2. DOC_POLICY.md
  3. PROJECT_DESCRIPTION.md
  4. TERMINOLOGY.md
  5. graphshell_docs/ — core app
  6. verso_docs/ — Verso mod (web rendering + bilateral sync)
  7. verse_docs/ — Verse mod (Tier 2 community network)
  8. nostr_docs/ — NostrCore mod
  9. matrix_docs/ — MatrixCore mod
  10. graphshell_docs/comms/ — optional hosted communication surfaces inside Graphshell hosting
  11. archive_docs/

Working Principles

  • Verify claims against the code/docs before repeating them as facts.
  • Keep active docs in the appropriate mod directory (graphshell_docs/, verso_docs/, verse_docs/, nostr_docs/, matrix_docs/), with hosted communication-surface docs under graphshell_docs/comms/; move superseded material to archive_docs/ checkpoints.
  • Prefer updating an existing doc over creating a new one unless the scope clearly requires a new category/resource.
  • Do not edit PROJECT_DESCRIPTION.md unless explicitly requested.
  • Keep this index aligned with folder structure and status in the same session as any doc changes.
  • If an AI note/memory adds a durable project principle, record it here under Working Principles.
  • If another index conflicts with this file, this file is authoritative and the others should be aligned.
  • Keep scaffold markers ([SCAFFOLD:<id>]) synchronized with the scaffold registry when integration status changes.
  • Migration Strategy: Iterative Replacement
    • Since there are no active users, we prioritize code cleanliness over backward compatibility. We will replace subsystems directly rather than maintaining parallel legacy paths.
  • When designing a new feature, ask:
    • Is the way you want this system to work consistent with our architectural guarantees (modularity, parallelization, access through intents and not direct state mutation, componentization as opposed to consolidation into monolithic core files, centralization of testing + diagnostic threading to automate testing)?
    • How can we refine the integration to meet our feature goals but respect our architecture?
  • Implementation feedback loop (DOC_POLICY §13): every implementation is also a design probe. After each implementation pass, disseminate structural learnings to the relevant plans/docs in the same session. If a carrier model, API surface, or data shape changes, check which downstream plans depend on the old shape and add dependency notes or blocking guards before the next dependent step proceeds. It is acceptable for a plan to describe something not yet fully implemented — it is not acceptable for a plan to be silent about an architectural problem visible in code.
  • For smolweb and middlenet content, prefer faithful protocol rendering plus optional assistive enrichment. Do not silently erase source protocol semantics in the name of convenience or polish.
  • For smolweb expansion, prioritize browser-maturity capabilities such as trust UX, subscription/source health, source/page tools, retention boundaries, and wayfinding before widening protocol surface area for its own sake.

Design Docs Index

Last updated: April 9, 2026 Project status source: ../README.md

Root Documents

Graphshell Active Docs

Graphshell Research

Graphshell Technical Architecture

Graphshell Implementation Strategy

Graphshell Design

Graphshell Testing

Verso Active Docs

Verso mod: web rendering (Servo + Wry) and bilateral P2P sync (Tier 1). See DOC_POLICY.md for boundary definition.

Verso Technical Architecture

Verso Implementation Strategy

Verso Research

  • verso_docs/research/2026-03-28_permacomputing_alignment.md - Permacomputing alignment: 10-principle audit, gaps (resource awareness, intentional forgetting, constrained hardware, small-web publishing, content portability), curated project index (Cable, Uxn, Coalescent Computer, Solar Protocol, snac, Cerca), and design posture summary.
  • verso_docs/research/2026-03-28_smolnet_follow_on_audit.md - Suitability audit for post-Gemini/Gopher/Finger smallnet follow-ons: admission bar for native Verso support, capability-family split (SimpleDocument bridge boundary, discovery vs messaging vs document lanes), and recommendations for Titan, Spartan, Misfin, Nex, and Guppy.
  • verso_docs/research/2026-03-28_smolnet_dependency_health_audit.md - Dependency-health rubric for follow-on smallnet protocol crates: when to prefer local implementations, when external Rust crates may be justified, and what still requires external ecosystem validation for Titan, Spartan, Misfin, Nex, and Guppy.

Verse Active Docs

Verse mod: public decentralized community network (Tier 2, long-horizon research). Not a Phase 5 dependency.

Verse Technical Architecture

Verse Implementation Strategy


NostrCore Active Docs

NostrCore mod: Nostr protocol integration.

NostrCore Technical Architecture

NostrCore Implementation Strategy


MatrixCore Active Docs

MatrixCore mod: Matrix room protocol for durable room membership and shared-space context.

MatrixCore Implementation Strategy


Graphshell Social Domain Docs

Graphshell social-domain docs cover hosted communication surfaces and related shell-side coordination rules without absorbing protocol authority from Verso, MatrixCore, NostrCore, or Verse.

Graphshell Social Implementation Strategy

Archive Checkpoints

  • archive_docs/checkpoint_2026-01-29/
  • archive_docs/checkpoint_2026-02-01/
  • archive_docs/checkpoint_2026-02-04/
  • archive_docs/checkpoint_2026-02-09/
  • archive_docs/checkpoint_2026-02-10/
  • archive_docs/checkpoint_2026-02-11/
  • archive_docs/checkpoint_2026-02-12/
  • archive_docs/checkpoint_2026-02-14_no_legacy_cleanup/
  • archive_docs/checkpoint_2026-02-16/
  • archive_docs/checkpoint_2026-02-17/
  • archive_docs/checkpoint_2026-02-19/
  • archive_docs/checkpoint_2026-02-20/
  • archive_docs/checkpoint_2026-02-23/registry_migration_plan.md, 2026-02-23_registry_architecture_critique.md (consolidated into 2026-02-22_registry_layer_plan.md)
  • archive_docs/checkpoint_2026-02-24/ — consolidated-plan redirects: 2026-02-24_input_surface_polish_plan.md, 2026-02-24_workspace_routing_polish_plan.md, 2026-02-24_sync_logic_validation_plan.md; GRAPHSHELL_P2P_COLLABORATION.md (pre-intent-model P2P design, superseded by verso_docs/technical_architecture/VERSE_AS_NETWORK.md and the Tier 1 sync plan)
  • archive_docs/checkpoint_2026-02-27/ — archived stale active docs: technical_architecture/DEVELOPER_GUIDE.md, technical_architecture/CODEBASE_MAP.md, testing/VALIDATION_TESTING.md; superseded by active codebase_guide.md and test_guide.md.
  • archive_docs/checkpoint_2026-03-01/ — bridge spike receipts and embedder-debt records for #180 and #183.
  • archive_docs/checkpoint_2026-03-05/2026-03-05_camera_navigation_fix_postmortem.md: root-cause and fix record for longstanding camera pan/zoom bug (dead metadata slot + every-frame fit reset).
  • archive_docs/checkpoint_2026-03-07/ — foundational reset receipt consolidation: archived 2026-03-06_foundational_reset_architecture_vision.md, 2026-03-06_foundational_reset_migration_governance.md, 2026-03-06_foundational_reset_demolition_plan.md, and 2026-03-06_clat_domain_state_core_extraction.md after consolidating active policy/progress into system_architecture_spec.md, 2026-03-06_foundational_reset_implementation_plan.md, and 2026-03-06_foundational_reset_graphbrowserapp_field_ownership_map.md.
  • archive_docs/checkpoint_2026-03-10/ — archived graphshell_docs/implementation_strategy/viewer/2026-02-26_composited_viewer_pass_contract.md after consolidating active compositor contract authority into implementation_strategy/PLANNING_REGISTER.md §0 and implementation_strategy/aspect_render/frame_assembly_and_compositor_spec.md; retained Appendix A future-work ideas live in PLANNING_REGISTER.md §0.10.
  • archive_docs/checkpoint_2026-03-18/ — completed registry/sector plans (system/2026-02-22_registry_layer_plan.md, system/register/ Sectors A/D/F), stabilization progress receipt, C+F backend bridge receipt, foundational-reset GraphBrowserApp field ownership snapshot, and superseded wgpu/WebRender deferred strategy docs (aspect_render/2026-02-27_egui_wgpu_custom_canvas_migration_strategy.md, aspect_render/2026-03-01_webrender_readiness_gate_feature_guardrails.md).
  • archive_docs/checkpoint_2026-03-27/ — archived completed graphshell_docs/technical_architecture/ARCHITECTURAL_CONCERNS.md after its open items were resolved and its historical references were superseded by active specs and overview docs.
  • archive_docs/checkpoint_2026-04-01/ — archived completed node-tagging plan history: graphshell_docs/implementation_strategy/graph/2026-02-20_node_badge_and_tagging_plan.md and graphshell_docs/implementation_strategy/graph/2026-03-31_node_badge_and_tagging_follow_on_plan.md; active authority remains graphshell_docs/implementation_strategy/graph/node_badge_and_tagging_spec.md.
  • archive_docs/checkpoint_2026-04-02/ — archived split-note compatibility redirects and superseded implementation-plan history, including graphshell_docs/implementation_strategy/subsystem_history/2026-02-11_bookmarks_history_import_plan.md after splitting it into the active bookmark-import and browser-history-import plans.
  • archive_docs/checkpoint_2026-04-03/ — archived graphshell_docs/implementation_strategy/viewer/2026-02-11_clipping_dom_extraction_plan.md as the landed clipping execution-slice record after splitting remaining viewer-lane work into the active graphshell_docs/implementation_strategy/viewer/2026-04-03_clipping_viewer_follow_on_plan.md.
  • archive_docs/checkpoint_2026-04-06/ — archived graphshell_docs/implementation_strategy/subsystem_ux_semantics/2026-03-23_navigator_host_runtime_naming_plan.md after the host-oriented runtime naming migration landed in workbench host state, persistence, and immediate desktop UI consumers; active chrome/host semantics remain in graphshell_docs/implementation_strategy/subsystem_ux_semantics/2026-03-13_chrome_scope_split_plan.md and the Navigator / Shell / Workbench specs.

Clone this wiki locally