docs(turboquote): document quote naming rules and the renew action - #137
Merged
amitsharma-turbodocx merged 1 commit intoAug 20, 2026
Merged
Conversation
yacinekahlerras-turbodocx
marked this pull request as ready for review
August 4, 2026 15:44
Quote names gained two behaviours that every SDK and API caller sees with no version bump, and neither was documented: - `name` is trimmed on create and update, and a whitespace-only name is a 400 - a duplicate is `Copy of <source>` capped at 255; the draft that the expired-quote endpoint creates keeps the ORIGINAL name, so repeated renewals never compound into `Copy of Copy of ...` Both matter because sending a quote snapshots its name onto the TurboSign document — that name is what signers read. Also corrects a pre-existing inaccuracy: all six SDK pages claimed `handleExpiredQuote` accepts "only void and decline". `renew` has been valid for some time, and it is the action whose naming behaviour this change describes, so leaving it undocumented made the new note unreadable. The pages now list all three actions and note that `reason` is optional for `renew` only. Adds a user guide for renaming a quote, covering both entry points, the naming rules, and why renaming is draft-only. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
amitsharma-turbodocx
force-pushed
the
docs/turboquote-rename-and-expiry-actions
branch
from
August 19, 2026 17:25
41ad0b6 to
785d9c4
Compare
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
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.
Description
TurboQuote's quote naming behaviour changed underneath API surface that already existed. No endpoint, request shape, or response shape moved — so callers see the change with no version bump and no compile error, and nothing in the docs mentioned it.
What's now documented
Across all six
docs/SDKs/quote-*.mdpages:nameis trimmed on create and update, and a whitespace-only name returns a400." Acme "is stored as"Acme"; interior spaces are untouched.Copy of <source>, truncated to the 255-character column limit.Copy ofprefix — so repeated renewals cannot compound intoCopy of Copy of ….All three matter for one reason: sending a quote snapshots its current name onto the TurboSign document, so that name is what signers read in the request email and on the signed PDF. Each page says so explicitly.
Pre-existing inaccuracy corrected
Every one of the six pages carried this:
renewhas been a valid action for some time (Joi.string().valid("void", "decline", "renew")), andreasonis optional for it. This wasn't introduced here, but it's the action whose naming behaviour item 3 describes — documenting the renewal rule while the page denied the action exists would have been unreadable. The pages now list all three and note thereasonrule.New user guide
docs/TurboQuote/Renaming a Quote.md— covers both rename entry points (the quote page header, and the ⋮ menu in the quotes list), the naming rules, why duplicates arrive asCopy of …, and why renaming is draft-only with the void-and-resend workaround.Screenshots — not included
This guide ships without screenshots. The repo's convention is
/guidewright-capture, which drives the live UI and draws the red click-target boxes; it isn't installed in the environment this was written in, and hand-cropped images wouldn't match the surrounding pages. The prose is structured so captures can be dropped in per step without restructuring.Happy to add them in a follow-up, or for a reviewer with the skill installed to run it on this branch.
Verification
Copy ofcapped at 255, renewals verified two levels deep.Pre-Review Checklist
develop, notmain🤖 Generated with Claude Code