ENG-958 - Obsidian documentation for Canvas feature

[trangdoan982]

Early merge so that Sean can test out and use the pre-release for tldraw

Summary by CodeRabbit

• Documentation
  • Added a comprehensive “Canvas” page in the Obsidian docs covering creation, editing, Discourse Nodes and Relations, auto-save, export options, UI overview, search workflows, performance tips, troubleshooting, and help resources. Includes images and GIFs.
  • Updated the Core Features navigation to include a “Canvas” link for quicker access to the new documentation.

[supabase]

This pull request has been ignored for the connected project zytfjzqyijgagqxrzbmz because there are no changes detected in packages/database/supabase directory. You can change this behaviour in Project Integrations Settings ↗︎.

---

Preview Branches by Supabase.
Learn more about Supabase Branching ↗︎.

[linear]

ENG-958 Initial Obsidian documentation for Canvas feature

[mdroidian]

@coderabbitai full review

[coderabbitai]

✅ Actions performed

Full review triggered.

[coderabbitai]

📝 Walkthrough

Walkthrough

Adds a new "Canvas" entry to the Obsidian docs navigation and introduces a new Canvas documentation page describing features, workflows, and troubleshooting.

Changes

Cohort / File(s)	Summary of Changes
Docs navigation update apps/website/app/(docs)/docs/obsidian/navigation.ts	Added "Canvas" item under Core Features with href ${ROOT}/canvas.
New Canvas docs page apps/website/app/(docs)/docs/obsidian/pages/canvas.md	Added a new markdown page detailing Canvas creation, editing, nodes/relations, features (auto-save, export), troubleshooting, and references to tldraw with images/gifs.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• Add documentation for tldraw Canvas feature #451 — Introduces the same Canvas docs page and navigation item; appears to be the directly corresponding PR.

Pre-merge checks

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title concisely identifies the purpose of the pull request by referencing the addition of Obsidian documentation for the Canvas feature and clearly relates to the changeset without extraneous details.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (1)

apps/website/app/(docs)/docs/obsidian/pages/canvas.md (1)

4-4: Consider adding an author name.

The author field is empty. If attribution is desired, consider adding the author's name.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a69b94e and bd57f28.

⛔ Files ignored due to path filters (12)

• apps/website/public/apps/assets/node-color-icon.svg is excluded by !**/*.svg
• apps/website/public/apps/assets/tool-arrow-icon.svg is excluded by !**/*.svg
• apps/website/public/docs/obsidian/adding-existing-relations.gif is excluded by !**/*.gif
• apps/website/public/docs/obsidian/canvas-icon-button.png is excluded by !**/*.png
• apps/website/public/docs/obsidian/create-canvas-command.png is excluded by !**/*.png
• apps/website/public/docs/obsidian/create-discourse-node.gif is excluded by !**/*.gif
• apps/website/public/docs/obsidian/create-relations.gif is excluded by !**/*.gif
• apps/website/public/docs/obsidian/export-options.png is excluded by !**/*.png
• apps/website/public/docs/obsidian/node-search.gif is excluded by !**/*.gif
• apps/website/public/docs/obsidian/open-canvas-command.png is excluded by !**/*.png
• apps/website/public/docs/obsidian/relation-error.png is excluded by !**/*.png
• apps/website/public/docs/obsidian/search-filtering.gif is excluded by !**/*.gif

📒 Files selected for processing (2)

• apps/website/app/(docs)/docs/obsidian/navigation.ts (1 hunks)
• apps/website/app/(docs)/docs/obsidian/pages/canvas.md (1 hunks)

🔇 Additional comments (3)

apps/website/app/(docs)/docs/obsidian/pages/canvas.md (2)

66-66: Verify the correct icon reference.

The instruction says "Click the Discourse Node icon" in the Relations section. Should this be "Discourse Relation icon" instead? Please verify that the correct icon is referenced.

---

7-125: Documentation is comprehensive and well-structured.

The Canvas documentation provides clear instructions, helpful visuals, and thorough troubleshooting guidance. The content effectively covers creation, editing, nodes, relations, features, and common issues.

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

58-61: Navigation entry properly integrated.

The Canvas navigation entry is correctly placed in the Core Features section and properly references the new documentation page at /docs/obsidian/canvas.

[mdroidian]

@trangdoan982 let's make sure to include linear tickets and call coderabbit, even for documentation.

[mdroidian]

Just noting: make sure to run this through coderabbit, even on docs
Also make sure to tie to a linear ticket.

Lastly, I made some comments on lowercase, as per our recent capitalization convention conversation. But feel free to leave them as is so that it is uniform with the rest, until ENG-892: go through and revert capitalization of branded components in the repo​

Worth noting for the future: based on that conversation, we'll also be going sentence case for headlines too (h1,h2,h3, **Bolded headlines**, etc), eg ### Create New Relations Between Nodes