-
Notifications
You must be signed in to change notification settings - Fork 4
Nodetag documentation #433
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
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
5bd5328
initial node tagging documentation page with gifs
mattakamatsu f958174
add instructions in tagging-candidate-nodes documentation
mattakamatsu 34e7319
JC edits 1 on tagging candidate nodes docs
mattakamatsu b125e55
add metadata
mdroidian ca83ad4
Format and Remove Title
mdroidian 31d25bb
move images and update links
mdroidian 93eaaaa
address comments about page title, simplify callout styling
mattakamatsu a672ea5
bold to italics for callout text
mattakamatsu File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
41 changes: 41 additions & 0 deletions
41
apps/website/app/(docs)/docs/roam/pages/tagging-candidate-nodes.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| --- | ||
| title: "Tagging Candidate Nodes" | ||
| date: "2025-09-16" | ||
| author: "" | ||
| published: true | ||
| --- | ||
|
|
||
| ## Purpose - quickly bookmark notes that could later become formal discourse nodes | ||
|
|
||
| While you're taking notes, often you'll write down something that could later become a formal discourse node like a Claim, Evidence, or Result. But sometimes you don't want to break your flow to formalize it in the moment, or you may want to clarify/revisit it later to be sure that you want to turn it into a Claim/Evidence/Result. | ||
| It's helpful to quickly tag these. Later, you can search for them and formalize them in one click. | ||
|
|
||
| ## Setup - define candidate nodes | ||
|
|
||
| In the discourse graphs settings, for each node type, list a "candidate node" tag label: | ||
|
|
||
|  | ||
|
|
||
| ⚠️ _Important: A tag cannot use text that is already part of its associated node's format. For example, if the "Claim" node format is CLM, you cannot use #CLM as its tag. You'll get an error message if you attempt to do this._ | ||
|
|
||
| ## Tag candidate nodes | ||
|
|
||
| Tag candidate nodes with the keyboard shortcut: `\` | ||
|
|
||
|  | ||
|
|
||
| Click or use the down arrow key to select a candidate node type. | ||
|
|
||
| 💡 _If you've customized the keyboard shortcut for creating nodes, this keyboard shortcut will change too_ | ||
|
|
||
| ## Formalize candidate nodes | ||
|
|
||
| Hover your mouse over the node tag, and click "Create Evidence" | ||
|
|
||
| <!-- TODO: update this gif with smoother UX, including auto-remove tag --> | ||
|
|
||
|  | ||
|
|
||
| ## Candidate node styling | ||
|
|
||
| Candidate node styling is currently controlled in roam/css. You can borrow our node styling here: [template-lab CSS page](https://roamresearch.com/#/app/template-lab/page/X8V4gy32s) | ||
|
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. |
||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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.
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.
We should discuss and agree on a consistent capitalization convention for terms like Discourse Graphs, Discourse Nodes, Candidate Nodes, node types (e.g., Claim, Evidence, etc.), etc.
I added this as part of a GitHub issue: #7 but don't think it ever made it into Linear.
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.
connecting to discord poll (poll still open)