Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dedicated Architecture Documentation #30

Open
josephbirkner opened this issue Sep 29, 2023 · 0 comments
Open

Dedicated Architecture Documentation #30

josephbirkner opened this issue Sep 29, 2023 · 0 comments
Labels
Docs Improvements or additions to documentation

Comments

@josephbirkner
Copy link
Collaborator

It's crucial to document the workings of the viewport-driven update mechanism, given its complexity and involvement of multiple components and inter-process communication. This system also handles event cancellations for incoming viewport updates and requires proper request tracking. Understanding the lifetime management of various data representations—like features, attributes, and GLTF representations —is equally important. I envision a high-level overview that outlines these key behavioral aspects, serving as an entry point with references to the source code. This will equip potential contributors with a foundational understanding of the essential concepts before diving deeper into the codebase. Currently, there is only a (partially outdated) UML in the main README.

@josephbirkner josephbirkner added the Docs Improvements or additions to documentation label Sep 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant