Document the cross-card-table card move recipe#419
Conversation
There was a problem hiding this comment.
Pull request overview
This PR expands the Move a card documentation to explicitly describe the two-step workflow for moving a card across card tables by using a wormhole id as column_id, clarifying key behaviors around linking, validation, and asynchronous completion.
Changes:
- Adds a step-by-step “recipe” for cross-card-table moves via wormholes (create wormhole → move card onto wormhole).
- Clarifies constraints/behaviors for wormhole moves (requires linked wormhole, async completion,
positionvalidation/limitations). - Improves discoverability by linking directly to the card table wormholes documentation.
Tip
If you aren't ready for review, convert to a draft PR.
Click "Convert to draft" or run gh pr ready --undo.
Click "Ready for review" or run gh pr ready to reengage.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 9c0280c5e2
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
9c0280c to
46dbb3c
Compare
46dbb3c to
3f1f598
Compare
The Move a card section noted that column_id could be a wormhole id but left the workflow for the reader to assemble. Spell it out: link the card table wormholes endpoints directly and give the two-step recipe for moving a card onto another card table, which may be in another project. Clarify the contract that's easy to get wrong: - Only linked wormholes accept a card; the card table's wormholes array also lists unlinked ones, and moving onto those returns 404 Not Found. - A valid position does not control where a teleported card lands — placement is decided when the asynchronous move completes — but an invalid position still returns 400 Bad Request. - The 204 means the teleport was queued; completion is asynchronous, the response does not expose the destination card's new id, and the original card id returns 404 once the move completes.
3f1f598 to
1432ab8
Compare
The Move a card section already mentioned that
column_idcan be a wormholeid, but left the reader to assemble the workflow. This spells it out in one place.What's now documented:
id."linked": trueaccept a card; moving onto an unlinked one returns404 Not Found.positiondoes not control where a teleported card lands (placement is decided when the asynchronous move completes), but an invalidpositionstill returns400 Bad Request.204means the teleport was queued; completion is asynchronous, the response does not expose the destination card's new recording id, and the original card id returns404 Not Foundonce the move completes.Docs only — one file, no new endpoints.