docs(mcp): state the north convention in the garden-house template - #584
Merged
Conversation
`two-bedroom.ts:13-14` documents that positive z points south; `garden-house.ts` relied on the same convention without saying so, which read as a contradiction (#362 was filed partly on that basis). The geometry already agrees — `wall_n` sits at `-HOUSE_D`, `wall_s` at `+HOUSE_D`, and `zone_garden` extends further into -z — so this records the assumption rather than changing it. The `GARDEN_DEPTH` comment said "along +z direction" while the garden is built at `-HOUSE_D - GARDEN_DEPTH`; corrected to -z. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Piece 1 of #362, split out because it's a comment-only change with no design decision attached.
packages/mcp/src/templates/two-bedroom.ts:13-14documents the coordinate system —xeast/west,znorth/south, positive z points south.garden-house.tsuses the same convention but never states it, which is why #362 read the two templates as disagreeing about north. They don't:wall_nis at-HOUSE_D,wall_sat+HOUSE_D, andzone_gardenextends to-HOUSE_D - GARDEN_DEPTH, i.e. further into −z. The geometry agrees; only the prose was missing.Two changes, both comments:
garden-house.tsheader.GARDEN_DEPTHcomment, which said "along +z direction" while the garden is built at-HOUSE_D - GARDEN_DEPTH(−z).No behaviour change;
templates.test.tsunaffected. The substantive half of #362 — a first-classnorthDirectionon Site/Building plus the MCP contract — stays open and needs a schema design call first.Co-Authored-By: Claude Opus 5 noreply@anthropic.com
Note
Low Risk
Comment-only changes in an MCP template file with no logic or schema impact.
Overview
Documentation-only update to
garden-house.tsso its north/south convention matchestwo-bedroom.tsand the actual geometry.Adds a coordinate system note in the file header:
[x, z]on the XZ plane, positive z is south. Corrects theGARDEN_DEPTHcomment from “along +z” to along −z (north), aligning prose with how the garden zone is built at-HOUSE_D - GARDEN_DEPTH.No runtime or template output changes.
Reviewed by Cursor Bugbot for commit b586e11. Bugbot is set up for automated code reviews on this repo. Configure here.