Skip to content

Commit 67c530b

Browse files
authored
[ENG-927] Node tags documentation (#535)
* first commit * finished documentation
1 parent 1642ff7 commit 67c530b

File tree

7 files changed

+70
-0
lines changed

7 files changed

+70
-0
lines changed

apps/website/app/(docs)/docs/obsidian/navigation.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,10 @@ export const navigation: NavigationList = [
5959
title: "Canvas",
6060
href: `${ROOT}/canvas`,
6161
},
62+
{
63+
title: "Node tags",
64+
href: `${ROOT}/node-tags`,
65+
},
6266
],
6367
},
6468

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: "Node tags"
3+
date: "2025-10-15"
4+
author: ""
5+
published: true
6+
---
7+
8+
## Overview
9+
10+
Node tags allow you to quickly create discourse nodes from tagged lines in your notes. When you assign a tag to a node type, any line containing that tag becomes a clickable element that can be converted into a discourse node.
11+
12+
This feature streamlines your workflow by letting you mark potential discourse nodes with tags as you write, then easily convert them to full discourse nodes later.
13+
14+
## Setting up node tags
15+
16+
### Configuring tags in settings
17+
18+
1. Open the Discourse Graph settings
19+
2. Navigate to the **Node Types** section
20+
3. Select an existing node type or create a new one
21+
4. In the **Node tag** field, enter a tag identifier
22+
23+
![Node tags setting](/docs/obsidian/node-tags-setting.png)
24+
25+
### Tag naming rules
26+
27+
Tags must follow these rules:
28+
- **No spaces**: Tags cannot contain whitespace
29+
- **Allowed characters**: Only letters (a-z, A-Z), numbers (0-9), and dashes (-)
30+
- **No special characters**: Characters like #, @, /, \, etc. are not allowed
31+
- **Case-sensitive**: Tags are case-sensitive in the editor
32+
33+
#### Tag examples
34+
35+
**Valid tags:**
36+
- `clm-candidate`
37+
- `question-idea`
38+
- `evidence2024`
39+
- `my-argument`
40+
41+
**Invalid tags:**
42+
- `clm candidate` (contains space)
43+
- `#clm-candidate` (contains #)
44+
- `clm/candidate` (contains /)
45+
46+
## Using node tags in your notes
47+
48+
### Adding tags to your notes
49+
50+
Once you've configured a node tag for a node type, simply add the tag (prefixed with `#`) to any line in your notes:
51+
52+
![Node tags example](/docs/obsidian/node-tags-example.png)
53+
54+
### Creating discourse nodes from tags
55+
56+
When you hover over a tagged line, a button appears above the tag:
57+
58+
1. **Hover** over the tag you want to convert
59+
2. Wait for the **"Create [Node Type]"** button to appear
60+
![On hover](/docs/obsidian/on-hover-node-tag.png)
61+
3. **Click** the button to open the node creation dialog
62+
![Node creation dialog](/docs/obsidian/create-node-dialog-node-tag.png)
63+
4. Click "Confirm" to create node
64+
65+
You'll see that the candidate node is now replaced with a formalized node
66+
![node created from tag](/docs/obsidian/node-tag-created.png)
120 KB
Loading
59 KB
Loading
59.9 KB
Loading
699 KB
Loading
29.1 KB
Loading

0 commit comments

Comments
 (0)