Skip to content

docs(templating): how to build a template in the browser - #152

Open
yacinekahlerras-turbodocx wants to merge 3 commits into
developfrom
feature/block-template-editor-docs
Open

docs(templating): how to build a template in the browser#152
yacinekahlerras-turbodocx wants to merge 3 commits into
developfrom
feature/block-template-editor-docs

Conversation

@yacinekahlerras-turbodocx

Copy link
Copy Markdown
Contributor

What this adds

A new how-to for building a template in the browser — no Word or Google Docs involved:

docs/TurboDocx Templating/How to Build a Template in the Browser.md

It walks the full path a first-time user takes:

  1. Templates → New Template
  2. Choose Build in browser
  3. Insert a variable with @
  4. Format with /
  5. Add blocks with the + button — with worked examples for a heading and a table
  6. Name it and Create Template
  7. Fill the variables and Generate Deliverable

Screenshots

Ten screenshots captured against the live app, each with a red box drawn on the exact element the step tells the reader to click. All are 1920×905, matching the other walkthroughs in this section.

The boxes are injected into the live DOM and measured from each element's own rect, so they land on the target rather than being painted at guessed coordinates.

Scope

Written as a how-to — the steps stay a recipe. Context that isn't an action ("when to use this", "editing the template later") sits in callouts instead of interrupting the flow, and readers who already have a .docx/.pptx are pointed at the existing upload guide rather than this one.

Sidebar position 4, next to the other "how to create a template" pages.

Documents the in-browser block editor: Templates > New Template > "Build in
browser", writing content, inserting variables with "@", formatting with "/",
naming and creating the template, then generating a document from it.

Six screenshots captured against the live app at 1920x905 (matching the other
walkthroughs in this section), each with a red box drawn on the exact element
the step tells the reader to click.

Scoped as a how-to: the steps stay a recipe, and the "when to use this" and
"editing later" context sits in callouts rather than in the step flow. Points
readers with an existing .docx/.pptx at the upload guide instead.
Adds a step for the + add-block button that appears when you hover a line, and
walks two concrete examples through it: inserting a Heading 2 and inserting a
table, then filling the table's cells.

Previously the + button was only mentioned in passing in a callout, which left
readers who prefer the mouse over the "/" shortcut without a path to follow.

Four more screenshots at 1920x905, each with a red box on the element the step
names. Existing images renumbered so the filenames track the step order.
… screenshots

Two corrections.

**Scope.** The guide documented three ways to add content: the "@" variable
trigger, the "/" formatting menu, and the + button. Only the + button has been
verified end to end, so the other two are removed rather than documented
untested. Everything is now added the same way — hover a line, click +, pick the
block — with worked examples for a heading and a table.

**Privacy.** The Templates-page screenshots showed real template names from the
test org, several of which are not fit for public documentation. Template names
and thumbnails are now blurred; the New Template button and the menu stay sharp
because that is what the steps point at. Nothing in the app was renamed.

Screenshots renumbered to a clean 1-8 sequence; the two orphaned images from the
removed steps are deleted. All 8 remain 1920x905.
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