Skip to content

Commit e060b08

Browse files
committed
Update README and deprecate Discourse Graphs documentation
- Added RoamJS logo to README and enhanced the description of the visual query builder. - Deprecated the Discourse Graphs section in documentation, directing users to the new Discourse Graphs extension.
1 parent 4cec04c commit e060b08

2 files changed

Lines changed: 11 additions & 47 deletions

File tree

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
1+
<a href="https://roamjs.com/">
2+
<img src="https://avatars.githubusercontent.com/u/138642184" alt="RoamJS Logo" title="RoamJS" align="right" height="60" />
3+
</a>
4+
15
# Query Builder
26

3-
Introduces new user interfaces for building queries in Roam.
7+
**Visual query builder for Roam: create and save queries via blocks, pages, or a drawer; add advanced logic (OR/NOT), then explore results as sortable/filterable tables or views like Kanban.**
8+
9+
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/RoamJS/query-builder)
410

511
![](https://firebasestorage.googleapis.com/v0/b/firescript-577a2.appspot.com/o/imgs%2Fapp%2Froamjs%2FYERyR8FnXO.png?alt=media&token=7522a921-3e17-424f-b141-08e4109f9b75)
612

@@ -22,7 +28,7 @@ For more information, check out our docs at [https://github.com/RoamJS/query-bui
2228
- [SmartBlocks Integration](https://github.com/RoamJS/query-builder/blob/main/docs/query-builder.md#smartblocks-integration)
2329
- [Developer API](https://github.com/RoamJS/query-builder/blob/main/docs/query-builder.md#developer-api)
2430
- [Examples](https://github.com/RoamJS/query-builder/blob/main/docs/query-builder.md#examples)
25-
- [Discourse Graphs](https://github.com/RoamJS/query-builder/blob/main/docs/discourse-graphs.md)
31+
2632
- [Native Roam Queries](https://github.com/RoamJS/query-builder/blob/main/docs/roam-queries.md#native-roam-queries)
2733
- [Creating Native Roam Queries](https://github.com/RoamJS/query-builder/blob/main/docs/roam-queries.md#creating-native-roam-queries)
2834
- [Manipulating Native Roam Queries](https://github.com/RoamJS/query-builder/blob/main/docs/roam-queries.md#manipulating-native-roam-queries)

docs/discourse-graphs.md

Lines changed: 3 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,6 @@
11
# Discourse Graphs
22

3-
This extension implements the Discourse Graph protocol, developed by Joel Chan.
3+
Deprecated. Use the Discourse Graphs extension instead.
44

5-
To enable the features associated with this protocol, toggle the `Discourse Graphs Enabled` switch.
6-
7-
For more about the suite of tools this mode brings, check out our documentation for how to use this extension at https://oasis-lab.gitbook.io/roamresearch-discourse-graph-extension/.
8-
9-
Contact Joel Chan (joelchan@umd.edu or [@JoelChan86](https://twitter.com/joelchan86) on Twitter or in the `#discourse-graph` channel on the [Academia Roamana Discord](https://discord.gg/FHrtGe25AJt)) for more details!
10-
11-
## Migrate to the Roam Depot Version
12-
13-
The Discourse Graph plugin is bundled with the Query Builder plugin.
14-
15-
To migrate to the new version, you must disable the old version in `roam/js`, then enable it in Query Builder.
16-
17-
### **Step 1**: Uninstall the `roam/js` Discourse Graph
18-
19-
- Open the `[[roam/js]]` page in your graph
20-
- Click on the "Stop this" button. It will look something like:
21-
22-
![](media/discourse-graph-stop.png)
23-
24-
- The end result should look like this:
25-
26-
![](media/discourse-graph-stopped.png)
27-
28-
**Important:** Once you see that, refresh your page by hitting the refresh button in your browser / device.
29-
30-
Then continue to: Step 2: Install Query Builder
31-
32-
**If you didn't see a yellow "Stop this" button, proceed follow these instructions:**
33-
34-
Find where you have installed Discourse Graph currently via `{{[[roam/js]]}}`. If you are unsure where you have Discourse Graph currently installed you can go to the `[[roam/js]]` page and look through the linked references. It will look something like:
35-
36-
![](media/discourse-graph-linked-ref.jpg)
37-
38-
### **Step 2**: Install Query Builder
39-
40-
![](media/settings-roam-depot.png)
41-
42-
![](media/settings-browse-extensions.png)
43-
44-
![](media/settings-install-query-builder.png)
45-
46-
### Step 3: Enable Discourse Graph within Query Builder
47-
48-
![](media/settings-enable-discourse-graph.png)
5+
- https://discoursegraphs.com/
6+
- https://github.com/DiscourseGraphs/discourse-graph/tree/main/apps/roam

0 commit comments

Comments
 (0)