Skip to content

docs: debugging instructions for docker#114

Merged
jandom merged 2 commits intomainfrom
jandom/2026-02/docs/debugging-instructions-for-docker
Feb 5, 2026
Merged

docs: debugging instructions for docker#114
jandom merged 2 commits intomainfrom
jandom/2026-02/docs/debugging-instructions-for-docker

Conversation

@jandom
Copy link
Collaborator

@jandom jandom commented Feb 5, 2026

Summary

While working on #101 I found it very useful to run with an interactive debugger. Decided to write some docs explaining how to set this up

Changes

See comments on the PR

Related Issues

Testing

Other Notes

@jandom jandom requested a review from jnwei February 5, 2026 16:42
@jandom jandom self-assigned this Feb 5, 2026
!openfold3/**
!scripts/** No newline at end of file
!scripts/**
!examples/**
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unrelated but helpful: we previously were excluding the JSON examples from the docker image, they're actually quite nice to have baked in

"pytest-xdist",
"pytest-cov",
"pytest-benchmark",
"debugpy",
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This allows for the interactive debugger, added as a test dep

Copy link
Contributor

@jnwei jnwei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall looks good! Thank you for adding this.

Under which tab do you think this should go in the documentation? Currently we follow the diataxis break down and you can see the organization of docs here: https://github.com/aqlaboratory/openfold-3/blob/main/docs/source/index.md?plain=1#L53-L86

Maybe this could go under deep-dives? It could potentially go under How-To, but it might be nice to separate this as a special "how to" for development.

@jandom
Copy link
Collaborator Author

jandom commented Feb 5, 2026

This is definitely a "how to" in my mind – let me update the contents.

@jandom jandom requested a review from jnwei February 5, 2026 20:15
Copy link
Contributor

@jnwei jnwei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jandom jandom merged commit f74b211 into main Feb 5, 2026
2 checks passed
@jandom jandom deleted the jandom/2026-02/docs/debugging-instructions-for-docker branch February 5, 2026 20:39
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.

2 participants