PIL-43 clipboard documentation - #1304
Conversation
KarolaKirsanow
added
the
documentation
PR size/scope checkThis PR is over our review-size guideline.
Please split this into smaller PRs unless there is a clear reason the changes need to land together. If keeping it as one PR, please add a brief justification covering:
|
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
| You can use the **Clipboard** to keep track of what's on the Canvas and what **should** be on the Canvas. It allows speedy bulk importation of all the nodes from a particular page or set of pages | ||
|
|
||
| ## Opening the Clipboard | ||
|
|
||
| Open the Clipboard by clicking on the Discourse Graph icon in the bottom toolbar, which will cause the Clipboard icon to appear. |
There was a problem hiding this comment.
🟡 New guide capitalizes generic feature words against the site's documentation style rule
Generic feature terms such as "Clipboard" and "Canvas" are written capitalized throughout the new guide (for example at apps/website/content/roam/guides/using-canvas-clipboard.mdx:12), which breaks the site's sentence-case documentation rule that reserves capitals for official product names and exact UI labels.
Impact: Documentation reads inconsistently with the rest of the site's pages.
Where the rule is defined and which lines violate it
apps/website/AGENTS.md states: "Use sentence case for documentation copy by default. Capitalize official product/plugin names and exact UI labels, buttons, or titles, but keep generic feature terms lowercase." The root AGENTS.md repeats it.
The page mixes both styles: the title and several headings use lowercase ("Using the canvas clipboard", "Dragging nodes onto the canvas"), while body copy uses "the Clipboard", "the Canvas", "Canvas page" (lines 12, 16, 23, 28-32, 39, 69, 80, 84, 88). Exact UI labels such as + Add page, Clear filters, Show nodes on canvas, and "Key Image" are correctly capitalized and should stay.
| You can use the **Clipboard** to keep track of what's on the Canvas and what **should** be on the Canvas. It allows speedy bulk importation of all the nodes from a particular page or set of pages | |
| ## Opening the Clipboard | |
| Open the Clipboard by clicking on the Discourse Graph icon in the bottom toolbar, which will cause the Clipboard icon to appear. | |
| You can use the clipboard to keep track of what's on the canvas and what **should** be on the canvas. It allows speedy bulk importation of all the nodes from a particular page or set of pages. | |
| ## Opening the clipboard | |
| Open the clipboard by clicking on the Discourse Graph icon in the bottom toolbar, which will cause the clipboard icon to appear. |
Was this helpful? React with 👍 or 👎 to provide feedback.
|
@KarolaKirsanow is attempting to deploy a commit to the Discourse Graphs Team on Vercel. A member of the Team first needs to authorize it. |
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
| The Clipboard can be used to search for pages with content relevant to your Canvas. | ||
|
|
||
|  | ||
| _Searching for pages to add to the cliipboard_ |
There was a problem hiding this comment.
Typo in documentation text. The word "cliipboard" has an extra 'i' and should be "clipboard".
-_Searching for pages to add to the cliipboard_
+_Searching for pages to add to the clipboard_| _Searching for pages to add to the cliipboard_ | |
| _Searching for pages to add to the clipboard_ | |
Spotted by Graphite
Is this helpful? React 👍 or 👎 to let us know.
|
|
||
| ## Finding and adding nodes | ||
|
|
||
| Clicking a node that's already on the canvas wil navigate to and select that node. |
There was a problem hiding this comment.
Typo in documentation text. The word "wil" is missing an 'l' and should be "will".
-Clicking a node that's already on the canvas wil navigate to and select that node.
+Clicking a node that's already on the canvas will navigate to and select that node.| Clicking a node that's already on the canvas wil navigate to and select that node. | |
| Clicking a node that's already on the canvas will navigate to and select that node. | |
Spotted by Graphite
Is this helpful? React 👍 or 👎 to let us know.
|
|
||
| ## Collapsing and closing | ||
|
|
||
| Use the minus icon in the Clipboard's header to collapse the panel without losing your added pages, or the close icon to hide it entirely. Your added pages and settings are saved per-canvas, so your saved pages will remain in the Clipbioard the next time you open it. |
There was a problem hiding this comment.
Typo in documentation text. The word "Clipbioard" has transposed letters and should be "Clipboard".
-Use the minus icon in the Clipboard's header to collapse the panel without losing your added pages, or the close icon to hide it entirely. Your added pages and settings are saved per-canvas, so your saved pages will remain in the Clipbioard the next time you open it.
+Use the minus icon in the Clipboard's header to collapse the panel without losing your added pages, or the close icon to hide it entirely. Your added pages and settings are saved per-canvas, so your saved pages will remain in the Clipboard the next time you open it.| Use the minus icon in the Clipboard's header to collapse the panel without losing your added pages, or the close icon to hide it entirely. Your added pages and settings are saved per-canvas, so your saved pages will remain in the Clipbioard the next time you open it. | |
| Use the minus icon in the Clipboard's header to collapse the panel without losing your added pages, or the close icon to hide it entirely. Your added pages and settings are saved per-canvas, so your saved pages will remain in the Clipboard the next time you open it. | |
Spotted by Graphite
Is this helpful? React 👍 or 👎 to let us know.
1 participant
This adds a short doc to roam/guides describing how to use the tldraw clipboard