docs: add quantum contributor documentation#3136
Open
Kryptos-FR wants to merge 6 commits intostride3d:masterfrom
Open
docs: add quantum contributor documentation#3136Kryptos-FR wants to merge 6 commits intostride3d:masterfrom
Kryptos-FR wants to merge 6 commits intostride3d:masterfrom
Conversation
8 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Details
Add in-repo technical documentation covering Stride's Quantum graph framework for engine contributors and maintainers.
Four new files under
docs/quantum/:README.md— entry point: five-layer architecture diagram, end-to-end data-flow walkthrough, decision tree for when Quantum code is actually needed, and a spoke-file mapgraph-model.md— coreStride.Core.Quantumlayer:IGraphNode/IObjectNode/IMemberNodetypes,NodeContainer, mutation API, change listeners, and listener lifetime rulesasset-graph.md—Stride.Core.Assets.Quantumlayer:AssetPropertyGraph, override model (inherited / overridden / new),AssetPropertyGraphDefinitionfor content-reference declaration,AssetQuantumRegistryregistrationproperty-grid.md— presenter layer:INodePresenter/IAssetNodePresenterkey members,INodePresenterUpdaterpipeline, full cookbook (hide a node, rename, add numeric constraints, make read-only, reorder, attach commands, add virtual nodes)Cross-references to
docs/asset-system/are included where the two systems meet (e.g. the Tier 1 / Tier 2 editor decision in the asset-system docs maps directly to the Quantum decision tree here).Note: Anthropic's Claude contributed to writing the doc.
Motivation
Quantum is one of the most opaque parts of the Stride editor codebase. Contributors working on new asset types or custom property grid behaviour (such as in #3103) frequently need to interact with it without any written guide. This documentation maps the five-layer stack, explains the override model, and provides a concrete INodePresenterUpdater cookbook so contributors can get productive without reverse-engineering the existing code.
Keeping it in-repo (following the precedent set in #3121) means it stays versioned alongside the code, is immediately discoverable when browsing the source, and is available to AI agents without any extra context setup.
Types of changes
Checklist