Repository navigation
docs(kanvas): document whiteboard behaviour changed by the capture-defect fixes #1369
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
42ba25c
390fb63
97e79c1
d37ce6a
2ee2eca
988d64b
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -44,7 +44,7 @@ You can switch between mouse modes using hotkeys or tool selection. Here are hot | |
|
|
||
| {{% tab header="Pencil Tool" lang="en" action="true" %}} | ||
|
|
||
| Pencil lines do not connect individual components, but offer annotating capability, allowing you to take notes and draw annotations to enhance your designs. | ||
| Pencil lines do not connect individual components, but offer annotating capability, allowing you to take notes and draw annotations to enhance your designs. A stroke can start, run and end over a component, so you can circle or underline anything on the canvas; while the Pencil is active, pressing on a component draws instead of moving it. | ||
|
|
||
| | Action | Cursor Style | Behavior | Example | | ||
| |-----------------------------|---------------------|--------------------------------------------------------|----------------------------------------------------------------| | ||
|
|
@@ -64,7 +64,7 @@ Pencil lines do not connect individual components, but offer annotating capabili | |
|
|
||
| {{% tab header="Pen Tool" lang="en" action="true" %}} | ||
|
|
||
| The Pen tool operates as a creator of annotation edges. Note that the pen tool has two behaviors depending upon the context in which you initiate the connection. | ||
| The Pen tool operates as a creator of annotation edges. Note that the pen tool behaves differently depending upon where you initiate the connection. | ||
|
|
||
| **To Activate:** `(CMD/CTRL)+E` | ||
|
|
||
|
|
@@ -73,6 +73,9 @@ The Pen tool operates as a creator of annotation edges. Note that the pen tool h | |
|
|
||
| - **Component-connect Behavior**: When you click an empty spot on the canvas, and drag to another empty spot on the canvas, you get a joint (aka a terminal node) from which you can create new connections as well as new edge relationships. | ||
| - **Canvas-connect Behavior**: When you click an empty spot on the canvas, and drag to an existing component, you get an annotation edge relationship. | ||
| - **Start on a component**: When you press on a component and drag, the connector starts from that component and follows it when it moves. | ||
|
|
||
| Connectors snap to the component under the cursor, never to a Pencil stroke drawn around it, and never back onto the component they started from. Pressing on a Pencil stroke or a connector's end point starts the connector from the component underneath it; a Pencil stroke is never either end of a connector. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Wrap the new Pen behavior paragraph. This Markdown line is excessively long and contributes to the reported MD013 line-length findings. Split the content into shorter sentences or bullets without changing its meaning. As per coding guidelines, ensure proper formatting in content.
|
||
|
|
||
| </details> | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -71,12 +71,20 @@ To hide or restore the whiteboard dock, right-click an empty area of the canvas, | |
|
|
||
| Shapes within the canvas offer flexibility. Select any shape to access a tooltip with options to resize, reshape, and change colors. This allows for precise adjustments similar to popular design software. | ||
|
|
||
| Dropping a shape on the canvas leaves your next click and keystrokes with the canvas and the tools. Dropping a component adds it without opening its configurator; double-click it to configure it. To label a shape, double-click it; press <kbd>Escape</kbd> or click elsewhere to finish. | ||
|
|
||
| #### Text Annotation Customization | ||
|
|
||
|  | ||
|
|
||
| Text annotations come with various options. Customize fonts, sizes, alignments, and styles easily. Text boxes resize for seamless integration with the canvas. | ||
|
|
||
| A text box you drop on the canvas opens for typing straight away, outlined while it has the keyboard. Press <kbd>Escape</kbd> or click elsewhere to finish. | ||
|
|
||
| #### Animating Components | ||
|
|
||
| Select a component or shape and choose **Node Animation** in its tooltip to draw attention to it: blink, ripple, bounce or pulse. Animations work on containers such as a Deployment as well as on single components, and they play again when the design is opened. Switching from one animation to another starts the new one straight away. They run at a calm pace, and Kanvas starts none when your system asks for reduced motion. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. One small question, non-blocking: "They run at a calm pace" is the only phrase in this paragraph a reader cannot act on - is there a concrete duration or speed behind it, or could the phrase be dropped? The rest of the paragraph is concrete (replay on open, switching starts the new one at once, reduced motion respected), so it stands fine without it. |
||
|
|
||
| #### Interactive Tooltip Interface | ||
|
|
||
|  | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Script executed:
Repository: layer5io/docs
Length of output: 35050
Clarify repeated merges for annotations.
The paragraph says annotations are always added, then says that merging the same design twice adds nothing. For a design with annotations, these statements conflict. State separately whether repeated merges suppress components and relationships while adding annotations.