Skip to content

Document local sibling-repo integration for XROMM workflows#3301

Open
homfunc wants to merge 1 commit into
DeepLabCut:mainfrom
homfunc:docs/phase3-integration-guides
Open

Document local sibling-repo integration for XROMM workflows#3301
homfunc wants to merge 1 commit into
DeepLabCut:mainfrom
homfunc:docs/phase3-integration-guides

Conversation

@homfunc
Copy link
Copy Markdown

@homfunc homfunc commented May 1, 2026

Summary

  • add README guidance for using this repo as a sibling checkout with XROMM_DLCTools and xmalab
  • add a new instructions.md describing the local integration layout and harness commands
  • document the smoke and end-to-end scenarios that rely on the sibling DeepLabCut checkout

Testing

  • documentation-only change

Context

Co-Authored-By: Oz oz-agent@warp.dev

Co-Authored-By: Oz <oz-agent@warp.dev>
@C-Achard C-Achard added enhancement New feature or request documentation documentation updates/comments labels May 4, 2026
@C-Achard C-Achard added the community-contribution Separate workflow/code contributed by DLC users: can be external notebooks, codes, repos, guides... label May 6, 2026
@C-Achard C-Achard marked this pull request as draft May 6, 2026 12:33
@C-Achard
Copy link
Copy Markdown
Collaborator

C-Achard commented May 6, 2026

Hello @homfunc,

Thanks for adding the documentation for your workflow. As part of a broader documentation update, we have integrated the DLC-Utils package description into the docs (see #3309).
This page records several external repos and contributions, which we felt would be the most appropriate place to add the instructions you provided. As such, we adapted the docs you provided in #3311.

Please have a look at the PR whenever convenient; if you're happy with the changes (mostly Myst formatting), please let us know there and we'd be happy to merge it alongside other documentation updates.
We of course added you as co-author on the commits of that branch, so your contribution will be fully preserved.

Let us know if you have any questions or if we can assist in any way.

Best,
Cyril

@homfunc
Copy link
Copy Markdown
Author

homfunc commented May 7, 2026

Hello @C-Achard,

Thanks for looking at this PR. Unfortunately, I missed a bunch of commits and so will need to either withdraw this PR or ammend it (substantially). Let me prepare the proper commits and then see where we are at.

@C-Achard
Copy link
Copy Markdown
Collaborator

C-Achard commented May 7, 2026

Hello @homfunc,

No worries, there shouldn't really be a need to substantially rework your contribution, your changes are already included in #3311 (unless you would like to make some changes there).
We were simply asking whether the adapted documentation in that PR looks correct to you: please see here.
(It's only two commits)

If you do still want to revise or withdraw your original PR, that is fine.
I just wanted to clarify that #3311 only contains the documentation derived from your contribution and should be easy to review; please have a quick look when convenient.

Best,
Cyril

@homfunc homfunc marked this pull request as ready for review May 7, 2026 08:50
@homfunc
Copy link
Copy Markdown
Author

homfunc commented May 7, 2026

Ok - I just checked and the rework is in XROMM_DLCTools repo, which I am about to submit a new PR for. I'll check that these instructions still work or amend if necessary but I think this is good to go.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

community-contribution Separate workflow/code contributed by DLC users: can be external notebooks, codes, repos, guides... documentation documentation updates/comments enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants