Skip to content

docs: add CONTEXT.md — a codebase glossary#71

Closed
bigmistqke wants to merge 2 commits into
solidjs-community:nextfrom
bigmistqke:docs/context-md
Closed

docs: add CONTEXT.md — a codebase glossary#71
bigmistqke wants to merge 2 commits into
solidjs-community:nextfrom
bigmistqke:docs/context-md

Conversation

@bigmistqke

Copy link
Copy Markdown
Contributor

Summary

Adds a root CONTEXT.md — a domain glossary for solid-three — establishing the canonical vocabulary for the codebase and recording the ambiguities/renames we've resolved. Also untracks docs/superpowers/ (local process artifacts that were committed in #62 despite being gitignored; files kept locally).

What's in CONTEXT.md

  • Element modelelement (any managed three.js value) vs object (an Object3D) vs instance (pre-built, via from).
  • Declaring / configuringentity (element-component), catalogue, T namespace; args, attach, dashed path.
  • RuntimeCanvas, Context, renderer (the concept behind gl), frame callback.
  • PluginsPlugin, selector, plugin prop (+ override), Register.
  • Events & pointersevent.object / currentObject, intersection, raycast vs tree propagation, pointer source / Pointer / raycaster / NDC, pointer capture / drag plane / hasPointerCapture.
  • Components & lifecyclePortal, Resource, Viewport, disposal, XR.
  • Plus Relationships, an example dialogue, and flagged ambiguities documenting each rename.

Decisions recorded for later cleanup PRs

  • glrenderergl is a misnomer once WebGPURenderer is supported; rename the Canvas prop + Context field later (keep gl as a deprecated alias for a release).
  • "contributed method" → plugin prop — rename the concept and code (resolvePluginMethods, etc.).

Notes

A domain glossary for solid-three: the element model (element vs object vs instance), declaration (entity / catalogue / T namespace), configuration (args / attach / dashed path), runtime (Canvas / Context / renderer), plugins (plugin prop / selector / override), events and the pointer system, and components & lifecycle. Includes relationships, an example dialogue, and flagged ambiguities recording the resolved renames.
@pkg-pr-new

pkg-pr-new Bot commented Jun 7, 2026

Copy link
Copy Markdown

commit: 03d940c

@bigmistqke

Copy link
Copy Markdown
Contributor Author

Folded into #63 — the CONTEXT.md glossary now ships there alongside the git-workflow docs (one "docs & process" change, one docs/superpowers untrack). Closing.

@bigmistqke bigmistqke closed this Jun 7, 2026
@bigmistqke bigmistqke deleted the docs/context-md branch June 7, 2026 09:13
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