Skip to content

Popup - #24

Merged
dprada merged 7 commits into
mainfrom
popup
Dec 7, 2025
Merged

Popup#24
dprada merged 7 commits into
mainfrom
popup

Conversation

@dprada

@dprada dprada commented Dec 7, 2025

Copy link
Copy Markdown
Contributor

This pull request brings several documentation updates and improvements for developer and contributor workflows, clarifies the architecture and synchronization mechanisms between Python and TypeScript layers, and adds checkpoint documentation for new features. The changes focus on making the development process clearer, improving onboarding, and documenting the implementation status of regions/layers and the new popup feature.

Developer workflow and repository structure:

  • Updated documentation to clarify that the JavaScript bundle (molsysviewer/viewer.js) is now tracked in the repository so users do not need a Node/TypeScript toolchain, and provided more precise instructions for rebuilding and updating checkpoints. [1] [2]
  • Fixed and standardized paths for conda environment files and directories, and updated Python file references for clarity. [1] [2] [3] [4] [5] [6]

Contribution and build artifact guidance:

  • Improved contributor guidelines to specify the correct TypeScript source directory and clarified the build artifact workflow.
  • Added explicit instructions in AGENTS.md to not read or edit generated files (viewer.js, viewer.js.map), emphasizing that only TypeScript sources should be referenced for logic changes.

Architecture and implementation documentation:

  • Added a comprehensive architecture document detailing the Python↔TypeScript message protocol, data flows, visibility handling, regions/layers API, and the new popup synchronization mechanism.
  • Updated checkpoint documentation for regions/layers to reflect that the messaging schema and acknowledgment path are now implemented, and clarified the current status and pending improvements.
  • Added a new checkpoint document describing the popup ("popout") feature: its objectives, current implementation, synchronization details, limitations, and next steps.

@dprada dprada self-assigned this Dec 7, 2025
@dprada
dprada merged commit c4a9e00 into main Dec 7, 2025
1 of 7 checks passed
@dprada
dprada deleted the popup branch December 7, 2025 22:06
dprada added a commit that referenced this pull request Jul 7, 2026
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